GET
/
v1
/
users
curl "https://api.zquenceeee.com/v1/users?page=1&page_size=20" \
  -H "x-api-key: $ZQUENCE_PUBLIC_KEY" \
  -H "x-api-secret: $ZQUENCE_SECRET_KEY"

{
  "users": [
    {
      "id": "6a25cdac36bc6230704b5b59",
      "name": "James Carter",
      "email": "james.carter@example.com",
      "phone": "+447911123456",
      "tenantId": "bc41c6ab-7206-4033-b632-4d1cfa86d840",
      "environmentId": "69f9b5fa0600ccbf9c677005",
      "customerId": "cus_Kq3mN8xLp2vT",
      "status": "active",
      "createdAt": "2026-05-20T10:30:00.000Z"
    },
    {
      "id": "6a25cdac36bc6230704b5b60",
      "name": "Emily Thompson",
      "email": "emily.thompson@example.com",
      "phone": "+14155550193",
      "tenantId": "bc41c6ab-7206-4033-b632-4d1cfa86d840",
      "environmentId": "69f9b5fa0600ccbf9c677005",
      "customerId": "cus_Rp7wQ2nMk4uS",
      "status": "inactive",
      "createdAt": "2026-06-01T09:00:00.000Z"
    }
  ],
  "total": 2,
  "page": 1,
  "pageSize": 20,
  "totalPages": 1
}
Returns customers belonging to the authenticated tenant. Without environmentId, results are scoped to the environment resolved from the authenticated API key (live keys return live customers, sandbox keys return sandbox customers). Pass environmentId explicitly to query a specific environment.
Requires the user.view.all permission on the authenticated API key or role.

​
Query parameters

​
page
integer
default:"1"
Page number (1-indexed).
​
page_size
integer
default:"10"
Number of results per page. Maximum 100.
​
search
string
Free-text search across name and email fields. Case-insensitive partial match.
​
environmentId
string
Filter results to customers in this specific environment. When provided, overrides the environment resolved from the API key.
Use the List environments endpoint to get valid environment IDs.

​
Returns

​
users
array
Array of customer objects for the current page.
​
total
number
Total number of customers matching the query.
​
page
number
Current page number.
​
pageSize
number
Page size in effect.
​
totalPages
number
Total number of pages.
Each users entry includes:
​
id
string
Customer’s MongoDB ObjectId.
​
name
string
Full display name.
​
email
string
Normalized lowercase email address.
​
phone
string
Normalized E.164 phone number.
​
tenantId
string
Owning tenant identifier.
​
environmentId
string | null
Primary environment this customer belongs to.
​
customerId
string | null
Your system’s identifier for this customer, if set via Add a customer or Add customers in bulk.
​
status
string
"inactive" — created but not yet accepted an invitation.
"active" — accepted at least one account invitation.
"disabled" — account disabled by admin.
​
createdAt
string
ISO 8601 UTC creation timestamp.

​
Error codes

StatusMeaning
401Missing or invalid API key pair.
403Caller does not have user.view.all permission.
curl "https://api.zquenceeee.com/v1/users?page=1&page_size=20" \
  -H "x-api-key: $ZQUENCE_PUBLIC_KEY" \
  -H "x-api-secret: $ZQUENCE_SECRET_KEY"

{
  "users": [
    {
      "id": "6a25cdac36bc6230704b5b59",
      "name": "James Carter",
      "email": "james.carter@example.com",
      "phone": "+447911123456",
      "tenantId": "bc41c6ab-7206-4033-b632-4d1cfa86d840",
      "environmentId": "69f9b5fa0600ccbf9c677005",
      "customerId": "cus_Kq3mN8xLp2vT",
      "status": "active",
      "createdAt": "2026-05-20T10:30:00.000Z"
    },
    {
      "id": "6a25cdac36bc6230704b5b60",
      "name": "Emily Thompson",
      "email": "emily.thompson@example.com",
      "phone": "+14155550193",
      "tenantId": "bc41c6ab-7206-4033-b632-4d1cfa86d840",
      "environmentId": "69f9b5fa0600ccbf9c677005",
      "customerId": "cus_Rp7wQ2nMk4uS",
      "status": "inactive",
      "createdAt": "2026-06-01T09:00:00.000Z"
    }
  ],
  "total": 2,
  "page": 1,
  "pageSize": 20,
  "totalPages": 1
}