Skip to main content
GET
curl

Authorizations

X-Api-Key
string
header
required

Your API key, sent as the value of the X-Api-Key header. In the dashboard, go to Integrations and open Deliveryman API Keys to create one.

Query Parameters

contact_list_uid
string
required

UID of the contact list to fetch contacts from.

Minimum string length: 1
limit
integer
default:100

Maximum number of records to return in this page. Must be between 1 and 100. Defaults to 100.

Required range: 1 <= x <= 100
offset
integer
default:0

Number of records to skip before returning results. For example, an offset of 0 starts at the first record, while an offset of 50 starts at the 51st. If the offset is greater than the number of available records, data is empty. Defaults to 0.

Required range: x >= 0

Response

Success

data
object[]
required

List of contacts.

total
integer
required

Total number of contacts in the contact list.

Required range: x >= 0