Sign in
Contact Lists

List contacts in a contact list

Retrieve a paginated list of contacts belonging to a specific contact list.

Returns external-safe contact fields: id, first_name, last_name, email, phone_number.
The list must belong to your organisation.

Authentication:
- API key with READ or READ_WRITE permission
get/contact-lists/{contact_list_id}/contacts

Request

  • Base URL: https://api.yourang.ai/v1
  • URL: https://api.yourang.ai/v1/contact-lists/{contact_list_id}/contacts
  • Auth: API Key (a scheme the document does not define)

Path parameters

contact_list_idstring uuid required

Query parameters

limitinteger

Maximum number of contacts to return

offsetinteger

Number of contacts to skip for pagination

Response

Successfully retrieved contacts in list

unknown required

Changes

No recorded changes to this endpoint across all 8 revisions of this API.