Skip to main content
GET
/
v1
/
customers
List customers
curl --request GET \
  --url https://api.quentli.com/v1/customers \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "cus_1234567890abcdefghij",
    "createdAt": "2025-01-10T12:00:00.000Z",
    "updatedAt": "2025-01-10T12:00:00.000Z",
    "name": "Juan Pérez",
    "username": "juan_perez_01",
    "organizationId": "org_1234567890abcdefghij",
    "acceptedServiceAgreement": true,
    "skipTaxInvoice": false,
    "emailVerified": false,
    "phoneNumberVerified": true,
    "hasChangedPassword": true,
    "email": "juan@example.com",
    "phoneNumber": "+525512345678",
    "secondaryPhoneNumber": null,
    "archivedAt": null,
    "archivedById": "u_1234567890abcdefghij",
    "signatureAcceptedAt": "2025-01-10T12:00:00.000Z",
    "optedOutWhatsappAt": null,
    "optedInWhatsappAt": "2025-01-05T10:00:00.000Z",
    "startedWhatsappAt": "2025-01-05T09:55:00.000Z",
    "replyWithAssistant": false,
    "metadata": [
      {
        "key": "studentId",
        "value": "A-1029"
      }
    ],
    "meta": {
      "studentId": "A-1029"
    }
  }
]

Documentation Index

Fetch the complete documentation index at: https://docs.quentli.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Organization API key using Authorization: Bearer sk_....

Query Parameters

​
filter
string

A qs-encoded customerFilter object.

Example:

"name[contains]=john&OR[0][noPayments]=true"

​
skip
number
default:0

Pagination offset.

Required range: x >= 0
Example:

0

​
take
number
default:20

Pagination limit.

Required range: 1 <= x <= 100
Example:

20

​
orderBy
string

A qs-encoded customerOrderBy object.

Example:

"createdAt=desc"

Response

Customers list

​
id
string
required

Unique identifier of the customer.

Example:

"cus_1234567890abcdefghij"

​
createdAt
required

Date and time when the customer was created.

Example:

"2025-01-10T12:00:00.000Z"

​
updatedAt
required

Date and time when the customer was last updated.

Example:

"2025-01-10T12:00:00.000Z"

​
name
string
required

Name of the customer.

Example:

"Juan Pérez"

​
username
string
required

Username used for customer login and customer identification.

Example:

"juan_perez_01"

​
organizationId
string
required

Identifier of the organization this customer belongs to.

Example:

"org_1234567890abcdefghij"

​
acceptedServiceAgreement
boolean
required

Whether the customer has accepted the service agreement.

Example:

true

​
skipTaxInvoice
boolean
required

Whether tax invoice generation is skipped for this customer.

Example:

false

​
emailVerified
boolean
required

Whether the customer has verified their email address.

Example:

false

​
phoneNumberVerified
boolean
required

Whether the customer has verified their phone number.

Example:

true

​
hasChangedPassword
boolean
required

Whether the customer has set a non-default password.

Example:

true

​
email
string | null

Email address of the customer.

Example:

"juan@example.com"

​
phoneNumber
string | null

Primary WhatsApp phone number of the customer, usually in E.164 format.

Example:

"+525512345678"

​
secondaryPhoneNumber
string | null

Secondary phone number used for reminders and announcements.

Example:

null

​
archivedAt

Date and time when the customer was archived.

Example:

null

​
archivedById
string | null

Identifier of the user who archived this customer.

Example:

"u_1234567890abcdefghij"

​
signatureAcceptedAt

Date and time when recurring charges terms were accepted via signature.

Example:

"2025-01-10T12:00:00.000Z"

​
optedOutWhatsappAt

Date and time when the customer opted out of WhatsApp reminders.

Example:

null

​
optedInWhatsappAt

Date and time when the customer opted in to WhatsApp reminders.

Example:

"2025-01-05T10:00:00.000Z"

​
startedWhatsappAt

Date and time when WhatsApp opt-in flow was started for this customer.

Example:

"2025-01-05T09:55:00.000Z"

​
replyWithAssistant
boolean | null

Whether to reply to this customer using the assistant.

Example:

false

​
metadata
object[] | null

Custom metadata entries attached to this customer as key-value pairs.

Example:
[{ "key": "studentId", "value": "A-1029" }]
​
meta
object

Flattened metadata map where each key maps to a string value.

Example:
{ "studentId": "A-1029" }