Onboarding V2

Changed on

Read one onboarding session's current view. Public, keyed on the session id — the frontend polls this for live status.

post/api/v1/onboarding.session.get

Request

  • Base URL: https://api.partly.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.partly.com/api/v1/onboarding.session.get
  • Auth: none declared

Request body

session_idstring uuid required

UUID value type

Response

200 OK

created_atstring date-time required

DateTime at a given timezone (RFC3339 format)

form_name'nz-workshop-v1' required
hubspot_deal_idstring required

UTF-8 encoded string

idstring uuid required

UUID value type

invited_user_emailsStdStringString[] required

Expandable array type

organization_idstring uuid required

UUID value type

organization_namestring required

UTF-8 encoded string

recipient_emailsStdStringString[] required

Expandable array type

requires_contractsboolean required

Boolean value

requires_payment_methodboolean required

Boolean value

updated_atstring date-time required

DateTime at a given timezone (RFC3339 format)

Changes

  • e1d6ccdf0c60Revision changes
    • breaking

      removed the required property /// from the response with the status

    • breaking

      removed the required property /// from the response with the status

    • info

      added the required property to the response with the status

  • d73948080dc7Revision changes
    • info

      endpoint added