Skip to main content
GET
/
v1
/
partners
List partners
curl --request GET \
  --url https://api.example.com/v1/partners
{
  "data": [
    {
      "email": "[email protected]",
      "created_at": "2025-04-30T16:44:13.000000Z",
      "updated_at": "2025-04-30T16:44:13.000000Z",
      "id": "partner_123",
      "name": "John",
      "surname": "Doe",
      "approved": true,
      "status": "active",
      "custom_fields": []
    }
  ],
  "links": {
    "first": "https://api.partnero.com/v1/partners?page=1",
    "last": null,
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "path": "https://api.partnero.com/v1/partners",
    "per_page": 15,
    "to": 1
  },
  "status": 1
}

​
Endpoint

GET https://api.partnero.com/v1/partners

​
Query parameters

ParameterTypeDefaultDescription
limitinteger15Number of results per page (1–250)
pageinteger1Page number for pagination

​
Request

cURL
curl --location 'https://api.partnero.com/v1/partners' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY'

​
Response

{
  "data": [
    {
      "email": "[email protected]",
      "created_at": "2025-04-30T16:44:13.000000Z",
      "updated_at": "2025-04-30T16:44:13.000000Z",
      "id": "partner_123",
      "name": "John",
      "surname": "Doe",
      "approved": true,
      "status": "active",
      "custom_fields": []
    }
  ],
  "links": {
    "first": "https://api.partnero.com/v1/partners?page=1",
    "last": null,
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "path": "https://api.partnero.com/v1/partners",
    "per_page": 15,
    "to": 1
  },
  "status": 1
}

​
Response fields

FieldTypeDescription
idstringUnique partner identifier
emailstringPartner’s email address
namestringPartner’s first name
surnamestringPartner’s last name
statusstringPartner status: active, pending, archived, deleted
approvedbooleanWhether the partner is approved
custom_fieldsarrayCustom signup field values
created_atstringISO 8601 timestamp
updated_atstringISO 8601 timestamp

​
Search partners

Use the search endpoint to find partners by ID, email, or referral key: 
GET https://api.partnero.com/v1/partners:search
ParameterTypeDescription
idstringPartner ID
emailstringPartner’s email address
keystringAny referral key belonging to the partner
curl --location 'https://api.partnero.com/v1/partners:[email protected]' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY'