Sign in
Contacts

List contacts

Returns the paginated list of contacts for the authenticated user. The top-level "total" field is the number of contacts matching the query filter, independent of skip/limit, so clients can drive server-side pagination.

get/contacts

Query parameters

skipinteger

number of contacts to skip

querystring

filter contacts containing query

sort_by'name' | 'updated_at'

field to sort contacts by

sort_descendingboolean

sort contacts in descending order

limitinteger

number of contacts to return

Response

OK

messagestring required
statusstring required
totalinteger required

Total is the number of contacts matching the request filter for the user, independent of the pagination skip/limit applied to Data.

Example response

{
  "data": [
    {
      "created_at": "2022-06-05T14:26:02.302718+03:00",
      "emails": [
        "alice@example.com"
      ],
      "id": "32343a19-da5e-4b1b-a767-3298a73703cb",
      "name": "Alice Smith",
      "phone_numbers": [
        "+18005550199",
        "+18005550100"
      ],
      "updated_at": "2022-06-05T14:26:02.302718+03:00",
      "user_id": "WB7DRDWrJZRGbYrv2CKGkqbzvqdC"
    }
  ],
  "message": "Request handled successfully",
  "status": "success",
  "total": 57
}

Changes