SellApp
ApiResourcesAffiliates

List affiliates

List store affiliates with profiles, counts, and integer-cent balances.

GET
/v2/affiliates

Authorization

bearerAuth storeAuth
AuthorizationBearer <token>

Provide your SellApp API key as a bearer token.

In: header

X-STORE<token>

Select the SellApp store for this API request.

In: header

Query Parameters

status?string

Filter by affiliate program status.

Value in"pending" | "active" | "disabled" | "rejected" | "blocked"
search?string

Search affiliate email addresses and profile identifiers.

Lengthlength <= 255
limit?integer

Number of items to return per page.

Default15
Range1 <= value <= 100
page?integer

Page number to return.

Default1
Range1 <= value

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://sell.app/api/v2/affiliates"
{
  "data": [
    {
      "id": 0,
      "email": "user@example.com",
      "status": "pending",
      "reason": "string",
      "payout_method": "string",
      "profile": {
        "id": 0,
        "identifier": "string",
        "bio": "string",
        "sites": [
          "http://example.com"
        ],
        "socials": [
          "http://example.com"
        ],
        "status": "pending",
        "email_subscribers": "string",
        "web_visitors": "string"
      },
      "balances": {
        "available_usd_cents": 0,
        "pending_usd_cents": 0,
        "paid_usd_cents": 0
      },
      "referrals_count": 0,
      "payouts_count": 0,
      "invited_at": "2019-08-24T14:15:22Z",
      "application_submitted_at": "2019-08-24T14:15:22Z",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  ],
  "links": {
    "first": "https://sell.app/api/v1/blacklists?page=1",
    "last": "https://sell.app/api/v1/blacklists?page=4",
    "prev": null,
    "next": "https://sell.app/api/v1/blacklists?page=2"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 4,
    "links": [
      {
        "url": "string",
        "label": "string",
        "active": true
      }
    ],
    "path": "https://sell.app/api/v1/blacklists",
    "per_page": 15,
    "to": 15,
    "total": 57
  }
}
{
  "message": "Unauthenticated."
}
{
  "message": "This action is unauthorized."
}
{
  "message": "The given data was invalid.",
  "errors": {
    "data": [
      "The data field is required."
    ]
  }
}