cURL
curl --request GET \
--url https://commet.co/api/v1/customers \
--header 'x-api-key: <api-key>'import { Commet } from "@commet/node";
const commet = new Commet({ apiKey: "ck_xxx" });
const response = await commet.customers.list();from commet import Commet
commet = Commet("ck_xxx")
customers_list_result = commet.customers.list()client, err := commet.New("ck_xxx")
if err != nil {
log.Fatal(err)
}
ctx := context.Background()
customersListResult, err := client.Customers.List(ctx, nil)
if err != nil {
log.Fatal(err)
}import co.commet.Commet;
import co.commet.params.ListCustomersParams;
var commet = Commet.builder().apiKey("ck_xxx").build();
var customersListResult = commet.customers().list(ListCustomersParams.builder().build());use Commet\Commet;
$commet = new Commet('ck_xxx');
$customersListResult = $commet->customers->list();{
"object": "list",
"data": [
{
"id": "cus_1a2b3c4d",
"externalId": null,
"fullName": "user@example.com",
"email": "user@example.com",
"taxDocument": null,
"documentType": null,
"timezone": "UTC",
"metadata": {},
"createdAt": "2026-09-07T12:00:00.000Z",
"updatedAt": "2026-09-07T12:00:00.000Z",
"object": "customer",
"livemode": false
}
],
"hasMore": false
}{
"error": {
"type": "validation_error",
"code": "validation_error",
"message": "The request contains an invalid parameter.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/validation_error.md"
}
}{
"error": {
"type": "authentication_error",
"code": "unauthorized",
"message": "A valid API key is required.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/unauthorized.md"
}
}{
"error": {
"type": "authentication_error",
"code": "forbidden",
"message": "You do not have permission to perform this operation.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/forbidden.md"
}
}{
"error": {
"type": "rate_limit_error",
"code": "rate_limited",
"message": "Too many requests. Retry after the interval specified in the Retry-After header.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/rate_limited.md"
}
}{
"error": {
"type": "internal_error",
"code": "internal_error",
"message": "An unexpected error occurred while processing the request.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/internal_error.md"
}
}Customers
List customers
List customers with cursor-based pagination.
GET
/
customers
cURL
curl --request GET \
--url https://commet.co/api/v1/customers \
--header 'x-api-key: <api-key>'import { Commet } from "@commet/node";
const commet = new Commet({ apiKey: "ck_xxx" });
const response = await commet.customers.list();from commet import Commet
commet = Commet("ck_xxx")
customers_list_result = commet.customers.list()client, err := commet.New("ck_xxx")
if err != nil {
log.Fatal(err)
}
ctx := context.Background()
customersListResult, err := client.Customers.List(ctx, nil)
if err != nil {
log.Fatal(err)
}import co.commet.Commet;
import co.commet.params.ListCustomersParams;
var commet = Commet.builder().apiKey("ck_xxx").build();
var customersListResult = commet.customers().list(ListCustomersParams.builder().build());use Commet\Commet;
$commet = new Commet('ck_xxx');
$customersListResult = $commet->customers->list();{
"object": "list",
"data": [
{
"id": "cus_1a2b3c4d",
"externalId": null,
"fullName": "user@example.com",
"email": "user@example.com",
"taxDocument": null,
"documentType": null,
"timezone": "UTC",
"metadata": {},
"createdAt": "2026-09-07T12:00:00.000Z",
"updatedAt": "2026-09-07T12:00:00.000Z",
"object": "customer",
"livemode": false
}
],
"hasMore": false
}{
"error": {
"type": "validation_error",
"code": "validation_error",
"message": "The request contains an invalid parameter.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/validation_error.md"
}
}{
"error": {
"type": "authentication_error",
"code": "unauthorized",
"message": "A valid API key is required.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/unauthorized.md"
}
}{
"error": {
"type": "authentication_error",
"code": "forbidden",
"message": "You do not have permission to perform this operation.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/forbidden.md"
}
}{
"error": {
"type": "rate_limit_error",
"code": "rate_limited",
"message": "Too many requests. Retry after the interval specified in the Retry-After header.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/rate_limited.md"
}
}{
"error": {
"type": "internal_error",
"code": "internal_error",
"message": "An unexpected error occurred while processing the request.",
"doc_url": "https://commet.co/docs/api-reference/2026-08-27/errors/internal_error.md"
}
}List customers with cursor-based pagination.
Autorizaciones
Encabezados
API version used by this reference. Send this header to select this contract explicitly.
Parámetros de consulta
Minimum string length:
1Rango requerido:
1 <= x <= 100¿Esta página le ayudó?