Skip to main content
GET
/
api
/
contact
List contacts
curl --request GET \
  --url https://api.hilos.io/api/contact \
  --header 'Authorization: <api-key>'
{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "jsmith@example.com",
      "meta": {},
      "external_url": "<string>",
      "canonical_phone": "<string>",
      "created_by": 123,
      "phone": "<string>",
      "created_on": "2023-11-07T05:31:56Z",
      "last_updated_on": "2023-11-07T05:31:56Z",
      "source": "<string>",
      "tags": [
        {
          "id": 123,
          "name": "<string>"
        }
      ],
      "id": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Token-based authentication with required prefix "Token"

Query Parameters

​
page
integer

A page number within the paginated result set.

​
page_size
integer

Number of results to return per page.

​
search
string

You can search with the base phone, first_name, last_name, email and external_url fields.

Response

200 - application/json
​
count
integer
Example:

123

​
next
string<uri> | null
Example:

"http://api.example.org/accounts/?page=4"

​
previous
string<uri> | null
Example:

"http://api.example.org/accounts/?page=2"

​
results
object[]