Retrieve a list of customers

get

https://platform.api.influence.io/v1/customers

This endpoint retrieves a list of customers from Influence. Results are paginated, and a cursor string is provided to fetch the next set of results. Each request will return a limited number of customers, and pagination can be controlled using the cursor string. N.B.: This API is stateless, meaning the order of customers in the response may change between requests as new customers are added or existing customers are deleted.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

string

cursor

string

Used for pagination. A string value will be returned from a previous response which you use here. NB: If cursor is included, do not include any other query parameters. They will be ignored.

pointBalanceMin

float

≥ 0

Minimum point balance for filtering customers.

pointBalanceMax

float

≥ 0

Maximum point balance for filtering customers.

createdAtMin

date-time

Minimum createdAt date for filtering customers (ISO8601 format).

createdAtMax

date-time

Maximum createdAt date for filtering customers (ISO8601 format).

updatedAtMin

date-time

Minimum updateAt date for filtering customers (ISO8601 format).

updatedAtMax

date-time

Maximum updateAt date for filtering customers (ISO8601 format).

lastSeenAtMin

date-time

Minimum lastSeenAtMin date for filtering customers (ISO8601 format).

lastSeenAtMax

date-time

Maximum lastSeenAt date for filtering customers (ISO8601 format).

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A list of customers.