TEtextla
Contacts

List contacts

Returns the cursor-paginated contacts of the authenticated account, each with its tags, groups, keywords and custom fields. The account ID is taken from the bearer token. The default page size is 100 and the default order is by ID, ascending. Pass next_cursor back as cursor for the next page; it is null on the last page. Reset cursor when changing sort_by or sort_dir.

get/contacts

Request

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

Query parameters

cursorstring

Opaque token for the next page

limitinteger

Maximum number of contacts to return; defaults to 100

sort_by'contact_type' | 'created_at' | 'full_name' | 'id' | 'phone' | 'signed_up_at' | 'updated_at'

Field to order the contacts by; reset cursor when changing it

sort_dir'asc' | 'desc'

Order direction: ascending or descending; reset cursor when changing it

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

next_cursorstring nullable required

Example response

{
  "$schema": "/v1/schemas/PageEnvelopeContact.json",
  "items": [
    {
      "$schema": "/v1/schemas/Contact.json"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.