Commet
  • Precios
Iniciar SesiónRegistrarse
Batch create customers POSTCreate customer POSTGet customer GETList customers GETUpdate customer PUT
DocumentaciónRecursosConstruir con AIAPI ReferenceWebhooks

List customers

List customers with cursor-based pagination.

GET
/customers

List customers with cursor-based pagination.

Authorization

ApiKeyAuth
x-api-key<token>

In: header

Query Parameters

externalId?string
limit?integer
cursor?string

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/customers"
{  "success": true,  "data": [    {      "id": "string",      "externalId": "string",      "fullName": "string",      "email": "string",      "timezone": "string",      "metadata": {        "property1": null,        "property2": null      },      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z",      "object": "customer",      "livemode": true    }  ],  "hasMore": true,  "nextCursor": "string"}
{  "success": false,  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}
{  "success": false,  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}
{  "success": false,  "error": {    "type": "string",    "code": "string",    "message": "string",    "param": "string",    "details": null,    "doc_url": "string"  }}

Get customer GET

Retrieve a customer by their public ID, including subscription status and metadata.

Update customer PUT

Update a customer's name, external ID, or metadata.