Skip to main content
GET
/
v1
/
customers
List customers
curl --request GET \
  --url https://api.example.com/v1/customers
{
  "data": [
    {
      "key": "customer_123",
      "partner": "partner_123",
      "deleted": false,
      "name": "Alice",
      "surname": "Brown",
      "email": "[email protected]",
      "created_at": "2025-05-02T16:12:39.000000Z",
      "updated_at": "2025-05-02T16:12:39.000000Z",
      "deleted_at": null
    }
  ],
  "links": {
    "first": "https://api.partnero.com/v1/customers?page=1",
    "last": null,
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "path": "https://api.partnero.com/v1/customers",
    "per_page": 15,
    "to": 1
  },
  "status": 1
}

​
Endpoint

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

​
Query parameters

ParameterTypeDefaultDescription
limitinteger15Number of results per page (1–250)
pageinteger1Page number for pagination
partner.keystring—Filter by partner’s referral key
partner.emailstring—Filter by partner’s email

​
Request

cURL
curl --location 'https://api.partnero.com/v1/customers' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY'
Filter by partner
curl --location 'https://api.partnero.com/v1/customers?partner.key=ref_123' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY'

​
Response

{
  "data": [
    {
      "key": "customer_123",
      "partner": "partner_123",
      "deleted": false,
      "name": "Alice",
      "surname": "Brown",
      "email": "[email protected]",
      "created_at": "2025-05-02T16:12:39.000000Z",
      "updated_at": "2025-05-02T16:12:39.000000Z",
      "deleted_at": null
    }
  ],
  "links": {
    "first": "https://api.partnero.com/v1/customers?page=1",
    "last": null,
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "path": "https://api.partnero.com/v1/customers",
    "per_page": 15,
    "to": 1
  },
  "status": 1
}

​
Response fields

FieldTypeDescription
keystringUnique customer identifier
emailstringCustomer’s email address
namestringCustomer’s first name
surnamestringCustomer’s last name
partnerstringKey of the partner who referred this customer
deletedbooleanWhether customer is soft-deleted
created_atstringISO 8601 timestamp
updated_atstringISO 8601 timestamp
deleted_atstring|nullDeletion timestamp if deleted

​
Search customers

Use the search endpoint to find customers by key, email, or ID: 
GET https://api.partnero.com/v1/customers:search
ParameterTypeDescription
idstringCustomer ID
emailstringCustomer’s email address
cURL
curl --location 'https://api.partnero.com/v1/customers:[email protected]' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY'