Skip to main content
GET
/
v1
/
customers
List customers
curl --request GET \
  --url https://api.quentli.com/v1/customers \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "<string>",
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "name": "<string>",
    "username": "<string>",
    "organizationId": "<string>",
    "acceptedServiceAgreement": true,
    "skipTaxInvoice": true,
    "emailVerified": true,
    "phoneNumberVerified": true,
    "hasChangedPassword": true,
    "email": "<string>",
    "phoneNumber": "<string>",
    "secondaryPhoneNumber": "<string>",
    "archivedAt": "<string>",
    "archivedById": "<string>",
    "signatureAcceptedAt": "<string>",
    "optedOutWhatsappAt": "<string>",
    "optedInWhatsappAt": "<string>",
    "startedWhatsappAt": "<string>",
    "replyWithAssistant": true,
    "metadata": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "meta": {}
  }
]

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.

​
createdAt
required

Date and time when the customer was created.

​
updatedAt
required

Date and time when the customer was last updated.

​
name
string
required

Name of the customer.

​
username
string
required

Username used for customer login and customer identification.

​
organizationId
string
required

Identifier of the organization this customer belongs to.

​
acceptedServiceAgreement
boolean
required

Whether the customer has accepted the service agreement.

​
skipTaxInvoice
boolean
required

Whether tax invoice generation is skipped for this customer.

​
emailVerified
boolean
required

Whether the customer has verified their email address.

​
phoneNumberVerified
boolean
required

Whether the customer has verified their phone number.

​
hasChangedPassword
boolean
required

Whether the customer has set a non-default password.

​
email
string | null

Email address of the customer.

​
phoneNumber
string | null

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

​
secondaryPhoneNumber
string | null

Secondary phone number used for reminders and announcements.

​
archivedAt

Date and time when the customer was archived.

​
archivedById
string | null

Identifier of the user who archived this customer.

​
signatureAcceptedAt

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

​
optedOutWhatsappAt

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

​
optedInWhatsappAt

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

​
startedWhatsappAt

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

​
replyWithAssistant
boolean | null

Whether to reply to this customer using the assistant.

​
metadata
object[] | null

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

​
meta
object

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