List onboardings | Pivotal Docs

const url = 'https://my.pivotal.app/api/v1/onboardings';
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": "onboarding",
      "id": "a3f1c9e2-7b4d-4f8a-9d3e-2b5f6c7d8e9f",
      "display_id": 1024,
      "customer_id": "cust_7890abc123",
      "template_id": "tmpl_456def789",
      "phase": "program_buildout",
      "state": "waiting",
      "started_at": "2024-04-01T08:00:00Z",
      "completed_at": null,
      "target_launch_date": "2024-06-15T00:00:00Z",
      "csm_id": "user_csm_001",
      "se_id": "user_se_002",
      "designer_id": "user_designer_003",
      "product_ops_id": "user_ops_004",
      "notes": "Client requested additional customization on the dashboard.",
      "waiting_on_customer": true,
      "waiting_on_customer_since": "2024-05-01T12:00:00Z",
      "wizard_completed_at": "2024-04-05T10:30:00Z",
      "reminder_email": true,
      "reminder_slack": false,
      "reminder_frequency_days": 7,
      "created_at": "2024-03-25T14:45:00Z",
      "updated_at": "2024-05-02T09:15:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "2024-05-02T09:15:00Z"
}

const url = 'https://my.pivotal.app/api/v1/onboardings';
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": "onboarding",
      "id": "a3f1c9e2-7b4d-4f8a-9d3e-2b5f6c7d8e9f",
      "display_id": 1024,
      "customer_id": "cust_7890abc123",
      "template_id": "tmpl_456def789",
      "phase": "program_buildout",
      "state": "waiting",
      "started_at": "2024-04-01T08:00:00Z",
      "completed_at": null,
      "target_launch_date": "2024-06-15T00:00:00Z",
      "csm_id": "user_csm_001",
      "se_id": "user_se_002",
      "designer_id": "user_designer_003",
      "product_ops_id": "user_ops_004",
      "notes": "Client requested additional customization on the dashboard.",
      "waiting_on_customer": true,
      "waiting_on_customer_since": "2024-05-01T12:00:00Z",
      "wizard_completed_at": "2024-04-05T10:30:00Z",
      "reminder_email": true,
      "reminder_slack": false,
      "reminder_frequency_days": 7,
      "created_at": "2024-03-25T14:45:00Z",
      "updated_at": "2024-05-02T09:15:00Z"
    }
  ],
  "has_more": true,
  "next_cursor": "2024-05-02T09:15:00Z"
}

Filter by customer_id, state, or phase. state=waiting is derived from waiting_on_customer = true. Cursor-paginated.

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).

customer_idstringOptional

Filter by customer (display_id or cuid).

stateenumOptional

Allowed values:

phaseenumOptional

Response

objectenum

Allowed values:

datalist of objects

has_moreboolean

next_cursorstring or null

Errors

401

Unauthorized Error

1	const url = 'https://my.pivotal.app/api/v1/onboardings';
2	const options = {
3	method: 'GET',
4	headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
5	body: '{}'
6	};
7
8	try {
9	const response = await fetch(url, options);
10	const data = await response.json();
11	console.log(data);
12	} catch (error) {
13	console.error(error);
14	}

1	{
2	"object": "list",
3	"data": [
4	{
5	"object": "onboarding",
6	"id": "a3f1c9e2-7b4d-4f8a-9d3e-2b5f6c7d8e9f",
7	"display_id": 1024,
8	"customer_id": "cust_7890abc123",
9	"template_id": "tmpl_456def789",
10	"phase": "program_buildout",
11	"state": "waiting",
12	"started_at": "2024-04-01T08:00:00Z",
13	"completed_at": null,
14	"target_launch_date": "2024-06-15T00:00:00Z",
15	"csm_id": "user_csm_001",
16	"se_id": "user_se_002",
17	"designer_id": "user_designer_003",
18	"product_ops_id": "user_ops_004",
19	"notes": "Client requested additional customization on the dashboard.",
20	"waiting_on_customer": true,
21	"waiting_on_customer_since": "2024-05-01T12:00:00Z",
22	"wizard_completed_at": "2024-04-05T10:30:00Z",
23	"reminder_email": true,
24	"reminder_slack": false,
25	"reminder_frequency_days": 7,
26	"created_at": "2024-03-25T14:45:00Z",
27	"updated_at": "2024-05-02T09:15:00Z"
28	}
29	],
30	"has_more": true,
31	"next_cursor": "2024-05-02T09:15:00Z"
32	}