Retrieve an onboarding | Pivotal Docs

const url = 'https://my.pivotal.app/api/v1/onboardings/17';
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": "onboarding",
  "id": "onb_9f8a7c6d4e3b2a1f",
  "display_id": 17,
  "customer_id": "cus_4b5d6e7f8a9b0c1d",
  "template_id": "tmpl_123abc456def7890",
  "phase": "program_buildout",
  "state": "active",
  "started_at": "2024-04-01T08:00:00Z",
  "completed_at": null,
  "target_launch_date": "2024-06-15T09:00:00Z",
  "csm_id": "user_csm_00123",
  "se_id": "user_se_00456",
  "designer_id": "user_designer_00789",
  "product_ops_id": "user_ops_00234",
  "notes": "Kickoff completed, awaiting final design approval.",
  "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": 3,
  "created_at": "2024-03-28T14:15:00Z",
  "updated_at": "2024-05-02T16:45:00Z"
}

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

idstringRequired

Numeric display_id or cuid of the onboarding.

Response

objectenum

idstring

display_idinteger

customer_idstring

template_idstring or null

phaseenum

stateenum

started_atdatetime

completed_atdatetime or null

target_launch_datedatetime or null

csm_idstring or null

se_idstring or null

designer_idstring or null

product_ops_idstring or null

notesstring or null

waiting_on_customerboolean

waiting_on_customer_sincedatetime or null

wizard_completed_atdatetime or null

reminder_emailboolean

reminder_slackboolean

reminder_frequency_daysinteger

created_atdatetime

updated_atdatetime

Errors

401

Unauthorized Error

404

Not Found Error