Retrieve a customer

Retrieve a customer object.

get

Retrieve a customer.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Bearer {apikey}

Path parameters

agentIdstringRequired

The ID of the agent.

customerIdstringRequired

The ID of the customer.

Responses

200

Successful Response

application/json

This an object representing a customer.

idstringOptional

phoneNumberstringOptional

firstNamestringOptional

lastNamestringOptional

aliasstringOptional

dobstring · dateOptional

pronounstringOptional

genderstringOptional

sexstring · enumOptionalPossible values:

preferredLanguagestringOptional

emailstringOptional

biostringOptional

photoURLstringOptional

facebookProfileURLstringOptional

instagramProfileURLstringOptional

tiktokProfileURLstringOptional

telegramProfileURLstringOptional

channelstringOptional

workplaceIdstringOptional

tagsstring[]Optional

createdAtstring · date-timeOptional

updatedAtstring · date-timeOptional

400

Bad Request

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

/v1/agents/{agentId}/customers/{customerId}

HTTPcURLJavaScriptPython

GET /v1/agents/{agentId}/customers/{customerId} HTTP/1.1
Host: api.voxity.ai
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "text",
  "phoneNumber": "text",
  "firstName": "text",
  "lastName": "text",
  "alias": "text",
  "dob": "2026-04-02",
  "pronoun": "text",
  "gender": "text",
  "sex": "male",
  "preferredLanguage": "text",
  "email": "text",
  "bio": "text",
  "photoURL": "text",
  "address": {
    "formatted": "text",
    "timezone": "text"
  },
  "facebookProfileURL": "text",
  "instagramProfileURL": "text",
  "tiktokProfileURL": "text",
  "telegramProfileURL": "text",
  "facebook": {
    "id": "text"
  },
  "instagram": {
    "id": "text",
    "username": "text"
  },
  "whatsapp": {
    "id": "text"
  },
  "tiktok": {
    "id": "text"
  },
  "telegram": {
    "id": "text"
  },
  "channel": "text",
  "workplaceId": "text",
  "tags": [
    "text"
  ],
  "phoneNumbers": [
    {
      "id": "text",
      "phoneNumber": "text",
      "type": "primary",
      "phoneType": "text",
      "lineType": "landline",
      "lineStatus": "active",
      "verified": true,
      "note": "text",
      "conversationSid": "text",
      "createdAt": "2026-04-02T06:22:05.924Z",
      "updatedAt": "2026-04-02T06:22:05.924Z"
    }
  ],
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "createdAt": "2026-04-02T06:22:05.924Z",
  "updatedAt": "2026-04-02T06:22:05.924Z"
}