Skip to main content
GET
/
customers
List available customers.
curl --request GET \
  --url https://1-some-client.some-server.healvi-chat/third-party/v1/customers \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 123,
      "channel": "bridge",
      "display_id": 4915223567929,
      "name": "John Doe",
      "profile": {
        "id": 123,
        "salutation": "formal_male",
        "name": "John Doe",
        "gender": "undisclosed",
        "blocked": true,
        "date_of_birth": "1970-01-01",
        "phone_number": "+4915224367929",
        "email": "jsmith@example.com",
        "address": "<string>",
        "custom_1": "<string>",
        "custom_2": "<string>",
        "custom_3": "<string>",
        "custom_4": "<string>",
        "custom_5": "<string>",
        "created_at": "2023-01-01T12:00:00Z",
        "updated_at": "2023-01-01T12:00:00Z"
      }
    }
  ],
  "links": {
    "first": "<string>",
    "last": "<string>",
    "prev": "<string>",
    "next": "<string>"
  },
  "meta": {
    "current_page": 123,
    "from": 123,
    "to": 123,
    "last_page": 123,
    "per_page": 123,
    "total": 123,
    "path": "<string>",
    "links": [
      "<any>"
    ]
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Success

data
object[]

Default count: 100

meta
object