REretellai

POST /list-contacts

Changed on

List contacts, newest created first by default, with the total count of matches alongside the page. Page through results with pagination_key; skip is available for offset-style paging but is slower on large contact sets and can repeat or miss rows as contacts are added or deleted.

Request

  • Base URL
    https://api.retellai.com
  • Auth
    HTTP bearer

Request body

limitnumber

Maximum number of contacts to return.

skipnumber

Number of records to skip for offset-based pagination.

sort_order'asc' | 'desc'

Sort contacts by created_timestamp in ascending or descending order (newest first by default). Ties are broken by contact ID in the same direction.

pagination_keystring

Base64url-encoded pagination key from a previous response.

search_querystring

Case-insensitive substring match against phone number, first name, last name, external ID, and custom field values. This is the only way to match on a contact's name.

excluded_contact_idsstring[]

Contact IDs to leave out of both the results and total, at most 1,000.

Response

Paginated list of contacts.

pagination_keystring

Pagination key for the next page.

has_moreboolean required

Whether more results are available.

totalnumber

Total count of contacts matching the filter.

Changes