Skip to main content
GET
/
profiles
/
{id}
Show profile by ID.
curl --request GET \
  --url https://1-some-client.some-server.healvi-chat/third-party/v1/profiles/{id} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "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"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.chat.voicebot.studio/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
integer
required

Response

200 - application/json

Success

​
data
object

Profile data of a customer. A profile can have many customers. A customer belongs to one profile. Can be used to connect a real person with multiple messengers (aka customers) to one profile.