List customers

GET

users

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

curl "https://api.zquence.ai/v1/users?environmentId=69f9b5fa0600ccbf9c677005&page_size=50" \
  -H "x-api-key: $ZQUENCE_PUBLIC_KEY" \
  -H "x-api-secret: $ZQUENCE_SECRET_KEY"

curl "https://api.zquence.ai/v1/users?search=james&page_size=10" \
  -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
}

{
  "statusCode": 403,
  "message": "Forbidden resource"
}

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 API-key scope tenant-users.read and tenant permission user.view.all.

Query parameters

integer

default:"1"

Page number (1-indexed).

integer

default:"10"

Number of results per page. Maximum 100.

string

Free-text search across name and email fields. Case-insensitive partial match.

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

array

Array of customer objects for the current page.

number

Total number of customers matching the query.

number

Current page number.

number

Page size in effect.

number

Total number of pages.

Each users entry includes:

string

Customer’s MongoDB ObjectId.

string

Full display name.

string

Normalized lowercase email address.

string

Normalized E.164 phone number.

string

Owning tenant identifier.

string | null

Primary environment this customer belongs to.

string | null

Your system’s identifier for this customer, if set via Add a customer or Add customers in bulk.

string

"inactive" — created but not yet accepted an invitation.
"active" — accepted at least one account invitation.
"disabled" — account disabled by admin.

string

ISO 8601 UTC creation timestamp.

Error codes

Status	Meaning
`401`	Missing or invalid API key pair.
`403`	Caller does not have `user.view.all` permission.

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

curl "https://api.zquence.ai/v1/users?environmentId=69f9b5fa0600ccbf9c677005&page_size=50" \
  -H "x-api-key: $ZQUENCE_PUBLIC_KEY" \
  -H "x-api-secret: $ZQUENCE_SECRET_KEY"

curl "https://api.zquence.ai/v1/users?search=james&page_size=10" \
  -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
}

{
  "statusCode": 403,
  "message": "Forbidden resource"
}

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

curl "https://api.zquence.ai/v1/users?environmentId=69f9b5fa0600ccbf9c677005&page_size=50" \
  -H "x-api-key: $ZQUENCE_PUBLIC_KEY" \
  -H "x-api-secret: $ZQUENCE_SECRET_KEY"

curl "https://api.zquence.ai/v1/users?search=james&page_size=10" \
  -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
}

{
  "statusCode": 403,
  "message": "Forbidden resource"
}

Introduction

Tenant

Environments

Customers

Accounts

KYC

Document reviews

Source of funds

Files

Webhooks

Sync

Sanctions

Query parameters

Returns

Error codes

​Query parameters

​Returns

​Error codes

Query parameters

Returns

Error codes