Get customers

get

https://api.phonelineplus.com/v2/customers

Retrieve a list of customers with optional filtering. If datefrom is omitted, only customers created in the last 7 days are returned. Pass an explicit datefrom to include older customers.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

limit

integer

1 to 100

Defaults to 10

The maximum number of items to return

offset

integer

0 to 9007199254740991

Defaults to 0

The number of items to skip

sort

string

enum

The field to sort by

Allowed:

datefrom

date

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$

Filter customers created on or after this date (ISO 8601 date). If omitted, defaults to 7 days ago — only recently created customers are returned.

dateto

date

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$

Filter customers created until this date

includeDeleted

boolean

Whether to include deleted customers

ascending

boolean

Sort in ascending order

searchTerm

string

Search term to filter customers

Response

Language

Credentials

Bearer

JWT

Loading…

Response

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

application/json

200