Get customers

get

https://api.inputkit.io/v3/customers

Get your customers paginated by 100 elements. Two important properties in the result: consent_sendings to know if the customer consent to receive sendings and unsubscribed_sms to know if the customer wants to receive SMS.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

consent_sendings

boolean

Defaults to false

True to get customers that consent to sendings, false to get customers that don't consent to sendings

string

Defaults to null

To search for a customer by name, email or phone number.

page

int32

Defaults to 1

The page you want to get.

created_from

date

Return only customers created on or after this date (UTC). Format: YYYY-MM-DD (e.g. 2025-01-15). ISO 8601 datetime is also accepted for precise filtering (e.g. 2025-01-15T14:30:00Z).

updated_from

date

Return only customers updated on or after this date (UTC). Uses updated_at, or created_at if the customer was never updated. Format: YYYY-MM-DD (e.g. 2025-06-01). ISO 8601 datetime is also accepted (e.g. 2025-06-01T00:00:00Z). When a date filter is used, results are sorted by updated_at ascending for stable pagination.

limit

int32

Defaults to 100

The number of customers to return per page. Defaults to 100 if not provided. Must be between 1 and 1000. Use with page to paginate through results.

Responses

Language

Credentials

Header

Loading…

Response

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

application/json

200200

400400