List People

Retrieve a paginated list of people (customers/contacts) in your workspace.

Method

GET /v1/people

Query Parameters

q · string

Optional free-text search (name, email, phone)

limit · integer

Items per page (default 50, max 100)

offset · integer

Number of items to skip (default 0)

Headers

Authorization · string · required

Bearer token (e.g. Authorization: Bearer YOUR_API_KEY)

cURL

curl "https://api.voyantcloud.com/v1/people?q=ana&limit=20&offset=0" \
  -H "Authorization: Bearer YOUR_API_KEY"

200 OK

{
  "data": [
    {
      "id": "p_123",
      "firstName": "Ana",
      "lastName": "Ionescu",
      "defaultEmail": "[e-mail]"
    }
  ],
  "meta": {
    "total": 1,
    "limit": 20,
    "offset": 0,
    "hasMore": false
  }
}