List a customer's onboardings

const url = 'https://my.pivotal.app/api/v1/customers/42/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": "onb_9f8a7c6d5e4b3a21",
      "display_id": 42,
      "customer_id": "cus_1234567890abcdef",
      "template_id": "tmpl_0987654321fedcba",
      "phase": "program_buildout",
      "state": "active",
      "started_at": "2024-04-01T10:00:00Z",
      "completed_at": null,
      "target_launch_date": "2024-06-15T09:00:00Z",
      "csm_id": "user_csm_001",
      "se_id": "user_se_002",
      "designer_id": "user_designer_003",
      "product_ops_id": "user_ops_004",
      "notes": "Kickoff completed, working on integration specs.",
      "waiting_on_customer": false,
      "waiting_on_customer_since": null,
      "wizard_completed_at": "2024-04-02T15:30:00Z",
      "reminder_email": true,
      "reminder_slack": false,
      "reminder_frequency_days": 7,
      "created_at": "2024-04-01T09:45:00Z",
      "updated_at": "2024-04-10T14:20:00Z"
    },
    {
      "object": "onboarding",
      "id": "onb_1a2b3c4d5e6f7g8h",
      "display_id": 41,
      "customer_id": "cus_1234567890abcdef",
      "template_id": null,
      "phase": "completed",
      "state": "active",
      "started_at": "2023-11-15T08:00:00Z",
      "completed_at": "2024-01-10T16:00:00Z",
      "target_launch_date": "2024-01-15T09:00:00Z",
      "csm_id": "user_csm_001",
      "se_id": "user_se_005",
      "designer_id": "user_designer_006",
      "product_ops_id": "user_ops_007",
      "notes": "Project successfully launched and closed.",
      "waiting_on_customer": false,
      "waiting_on_customer_since": null,
      "wizard_completed_at": "2023-11-16T12:00:00Z",
      "reminder_email": false,
      "reminder_slack": false,
      "reminder_frequency_days": 0,
      "created_at": "2023-11-14T15:00:00Z",
      "updated_at": "2024-01-11T10:00:00Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

const url = 'https://my.pivotal.app/api/v1/customers/42/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": "onb_9f8a7c6d5e4b3a21",
      "display_id": 42,
      "customer_id": "cus_1234567890abcdef",
      "template_id": "tmpl_0987654321fedcba",
      "phase": "program_buildout",
      "state": "active",
      "started_at": "2024-04-01T10:00:00Z",
      "completed_at": null,
      "target_launch_date": "2024-06-15T09:00:00Z",
      "csm_id": "user_csm_001",
      "se_id": "user_se_002",
      "designer_id": "user_designer_003",
      "product_ops_id": "user_ops_004",
      "notes": "Kickoff completed, working on integration specs.",
      "waiting_on_customer": false,
      "waiting_on_customer_since": null,
      "wizard_completed_at": "2024-04-02T15:30:00Z",
      "reminder_email": true,
      "reminder_slack": false,
      "reminder_frequency_days": 7,
      "created_at": "2024-04-01T09:45:00Z",
      "updated_at": "2024-04-10T14:20:00Z"
    },
    {
      "object": "onboarding",
      "id": "onb_1a2b3c4d5e6f7g8h",
      "display_id": 41,
      "customer_id": "cus_1234567890abcdef",
      "template_id": null,
      "phase": "completed",
      "state": "active",
      "started_at": "2023-11-15T08:00:00Z",
      "completed_at": "2024-01-10T16:00:00Z",
      "target_launch_date": "2024-01-15T09:00:00Z",
      "csm_id": "user_csm_001",
      "se_id": "user_se_005",
      "designer_id": "user_designer_006",
      "product_ops_id": "user_ops_007",
      "notes": "Project successfully launched and closed.",
      "waiting_on_customer": false,
      "waiting_on_customer_since": null,
      "wizard_completed_at": "2023-11-16T12:00:00Z",
      "reminder_email": false,
      "reminder_slack": false,
      "reminder_frequency_days": 0,
      "created_at": "2023-11-14T15:00:00Z",
      "updated_at": "2024-01-11T10:00:00Z"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Newest first. Not paginated — a customer rarely has more than a handful.

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.

Path parameters

customerIdstringRequired

Numeric display_id or cuid of the parent customer.

Response

objectenum

Allowed values:

datalist of objects

has_moreboolean

next_cursorstring or null

Errors

401

Unauthorized Error

404

Not Found Error

1	const url = 'https://my.pivotal.app/api/v1/customers/42/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": "onb_9f8a7c6d5e4b3a21",
7	"display_id": 42,
8	"customer_id": "cus_1234567890abcdef",
9	"template_id": "tmpl_0987654321fedcba",
10	"phase": "program_buildout",
11	"state": "active",
12	"started_at": "2024-04-01T10:00:00Z",
13	"completed_at": null,
14	"target_launch_date": "2024-06-15T09: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": "Kickoff completed, working on integration specs.",
20	"waiting_on_customer": false,
21	"waiting_on_customer_since": null,
22	"wizard_completed_at": "2024-04-02T15:30:00Z",
23	"reminder_email": true,
24	"reminder_slack": false,
25	"reminder_frequency_days": 7,
26	"created_at": "2024-04-01T09:45:00Z",
27	"updated_at": "2024-04-10T14:20:00Z"
28	},
29	{
30	"object": "onboarding",
31	"id": "onb_1a2b3c4d5e6f7g8h",
32	"display_id": 41,
33	"customer_id": "cus_1234567890abcdef",
34	"template_id": null,
35	"phase": "completed",
36	"state": "active",
37	"started_at": "2023-11-15T08:00:00Z",
38	"completed_at": "2024-01-10T16:00:00Z",
39	"target_launch_date": "2024-01-15T09:00:00Z",
40	"csm_id": "user_csm_001",
41	"se_id": "user_se_005",
42	"designer_id": "user_designer_006",
43	"product_ops_id": "user_ops_007",
44	"notes": "Project successfully launched and closed.",
45	"waiting_on_customer": false,
46	"waiting_on_customer_since": null,
47	"wizard_completed_at": "2023-11-16T12:00:00Z",
48	"reminder_email": false,
49	"reminder_slack": false,
50	"reminder_frequency_days": 0,
51	"created_at": "2023-11-14T15:00:00Z",
52	"updated_at": "2024-01-11T10:00:00Z"
53	}
54	],
55	"has_more": false,
56	"next_cursor": null
57	}