Skip to main content
POST
/
customers
/
search
cURL
curl --request POST \
  --url https://api.vooma.ai/v0/customers/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pagination": {
    "limit": 123,
    "after": "<string>",
    "before": "<string>",
    "last": 123,
    "first": 123
  },
  "filterById": "<string>",
  "search": "<string>"
}
'
{
  "customers": [
    {
      "name": "<string>",
      "externalIds": [
        {
          "type": "ALJEX",
          "value": "<string>"
        }
      ],
      "id": "<string>",
      "contacts": [
        {
          "carrierId": "<string>",
          "customerId": "<string>",
          "email": "<string>",
          "phone": "<string>",
          "name": "<string>",
          "id": "<string>"
        }
      ]
    }
  ],
  "pageInfo": {
    "endCursor": "<string>",
    "startCursor": "<string>",
    "hasPreviousPage": true,
    "hasNextPage": true
  },
  "totalCount": 123,
  "count": 123
}
Beta Feature: This functionality is currently in beta. You may experience changes or limited support as we continue to improve it.

Authorizations

Authorization
string
header
required

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

Body

application/json
pagination
object
filterById
string

Response

200 - application/json

Ok

customers
object[]
required
pageInfo
object
totalCount
number<double>
count
number<double>