List customers | Pivotal Docs

const url = 'https://my.pivotal.app/api/v1/customers';
const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "object": "list",
  "data": [
    {
      "object": "customer",
      "id": "clx9f8g7h6j5k4l3m2n1",
      "display_id": 101,
      "name": "Acme Corporation",
      "slug": "acme-corp",
      "domain": "acmecorp.com",
      "status": "active",
      "plan": "enterprise",
      "mrr": 125000,
      "monthly_orders": 320,
      "hubspot_company_id": "hs_987654321",
      "hubspot_deal_id": "deal_123456789",
      "stripe_customer_id": "cus_J5K8L9M0N1O2P3",
      "intercom_company_id": "intco_456789123",
      "slack_channel_id": "C024BE7LT",
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-04-20T14:45:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "2024-04-20T14:45:00Z"
}

Returns customers in the calling org, newest first. Cursor-paginated — pass next_cursor from a previous response back as cursor to get the next page.

Authentication

AuthorizationBearer

Send your key in the Authorization header. Keys start with pivotal_ (production) or pivotal_test_ (test mode, no side effects on integrations). Rotate keys from /admin/api-keys — old keys 401 instantly when revoked.

Query parameters

limitstringOptional

1–100, default 25.

cursordatetimeOptional

Pagination cursor from a previous response (ISO timestamp).

statusenumOptional

Allowed values:

Response

objectenum

datalist of objects

has_moreboolean

next_cursorstring or null

Errors

401

Unauthorized Error

429

Too Many Requests Error