Sign in
affiliate

Searches for the affiliates

get/admin/affiliates/search

Query parameters

instring[] required

The columns on which to search for the specified keyword

keywordstring required

The keyword to search for

fieldsstring[] required

Comma separated list of fields to return. See Affiliate Schema to get list of available fields

Limit number of results

sort_direction'asc' | 'desc'

The direction to sort the results

sort_column'name' | 'ref_code' | 'id'

The column to sort the results by

operator'starts_with' | 'ends_with' | 'contains'

The operator to use for matching the keyword

Response

Example response

{
  "affiliates": [
    {
      "id": 1,
      "name": "John Doe",
      "avatar": {},
      "first_name": "John",
      "last_name": "Doe",
      "email": "johndoe@example.com",
      "ref_code": "hs692n62d",
      "ref_codes": [
        "referralcode"
      ],
      "coupon": {
        "code": "JOHN10OFF",
        "discount_value": 10,
        "discount_type": "percentage"
      },
      "coupons": [
        {
          "code": "JOHN10OFF",
          "discount_value": 10,
          "discount_type": "percentage"
        }
      ],
      "phone": "1 888 (999) 1234",
      "address_1": "Address line 1",
      "city": "City",
      "state": "State",
      "country": "US",
      "zip_code": "121323232",
      "tax_identification_number": "788-21-1122",
      "comments": "Private comment",
      "personal_message": "Message to the affiliate",
      "payment_method": "paypal",
      "payment_details": {
        "paypal_email": "jdoe@paypal.com"
      },
      "commission": {
        "type": "percentage",
        "amount": 10,
        "on": "product"
      },
      "group_id": 10
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.