List all customers

Returns a list of customers.

The customers are returned sorted by creation date, with the most recent customer appearing first.

get

List all customers.

Authorizations

ApiKeyAuth

AuthorizationstringRequired

Bearer {apikey}

Path parameters

agentIdstringRequired

The ID of the agent.

Query parameters

limitinteger · max: 100Optional

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.

Default: 10

startingAfterstringOptional

A cursor for use in pagination. startingAfter is an opportunity ID.

endingBeforestringOptional

A cursor for use in pagination. endingBefore is an opportunity ID.

channelstring · enumOptional

Only return the customers for the specified channel.

Possible values:

emailstringOptional

Filters the list by the customer's email address. The filter is case-sensitive.

phonestringOptional

Filters the list by the customer's phone number.

tagsstringOptional

Filters the list by the customer's tags.

Responses

200

Successful Response

application/json

400

Bad Request

application/json

403

Forbidden

application/json

404

Not Found

application/json

get

/v1/agents/{agentId}/customers

HTTPcURLJavaScriptPython

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

{
  "hasMore": true,
  "data": [
    {
      "id": "text",
      "phoneNumber": "text",
      "firstName": "text",
      "lastName": "text",
      "alias": "text",
      "dob": "2025-12-09",
      "pronoun": "text",
      "gender": "text",
      "sex": "male",
      "preferredLanguage": "en",
      "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": "2025-12-09T20:55:37.699Z",
          "updatedAt": "2025-12-09T20:55:37.699Z"
        }
      ],
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "createdAt": "2025-12-09T20:55:37.699Z",
      "updatedAt": "2025-12-09T20:55:37.699Z"
    }
  ]
}

Tags Parameter Limitation

The tags query parameter currently filters customers using only the first tag provided. If multiple tags are specified in a comma-separated format, subsequent tags will be ignored.

Example:

• ?tags=vip ✅ Filters customers with the "vip" tag

• ?tags=vip,premium,gold ⚠️ Only filters customers with the "vip" tag (premium and gold are ignored)