Skip to main content
GET
/
api
/
customers
List Customers
curl --request GET \
  --url https://app.sphinxhq.com/api/customers/ \
  --header 'Authorization: Bearer <token>'
{
  "count": 123,
  "results": [
    {
      "id": 123,
      "external_id": "<string>",
      "full_name": "<string>",
      "input_details": {},
      "sync_platforms": {},
      "delete_after": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

Authorizations

​
Authorization
string
header
required

OAuth2 access token obtained from POST /api/oauth/token/ using client credentials.

Query Parameters

​
customer_type
enum<string>

Filter by customer type (INDIVIDUAL or COMPANY)

Available options:
COMPANY,
INDIVIDUAL
​
external_id
string

Filter by external ID

​
page
integer

A page number within the paginated result set.

​
page_size
integer

Number of results to return per page.

​
search
string

Search customers by name

Response

200 - application/json
​
count
integer
required
Example:

123

​
results
object[]
required
​
next
string<uri> | null
Example:

"http://api.example.org/accounts/?page=4"

​
previous
string<uri> | null
Example:

"http://api.example.org/accounts/?page=2"