Skip to main content
GET
List the contacts in a contacts list or contact search

Authorizations

Authorization
string
header
required

Account API key passed in the Authorization header

Path Parameters

contactsListID
string
required

Contacts list or contact search UUID

Query Parameters

account_id
string

Target account UUID. Required for staff; ignored for customer keys.

limit
integer<int64>
default:100

Maximum contacts to return

Required range: 1 <= x <= 250
offset
integer<int64>
default:0

Number of contacts to skip

Required range: x >= 0

Response

OK

contacts
object[] | null
required
contacts_list_id
string
required
limit
integer<int64>
required
offset
integer<int64>
required
total
integer<int64>
required

Total contacts in the list, so a caller can tell a short page from the last one