Contacts

List Contacts

Returns a paginated list of contacts, ordered by nickname. Use the limit and offset query parameters to page through results.

get/contacts

Request

Query parameters

nickname_querystring nullable

Optional filter to search contacts by nickname.

limitinteger

Maximum number of results to return.

offsetstring nullable

Opaque offset identifier for pagination. Use the nextOffset from a previous response.

Headers

x-entity-idstring uuid

Optional entity_id to scope requests to a specific entity.

Response

Successful Response

Example response

{
  "page": {
    "nextOffset": "qwer123454q2f"
  }
}

Changes

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