/api/v1/onboarding
Response
200The onboarding info.
| intent | "sales" | "hiring" | "fundraising" | "partnerships" | "events" | "other" | null Why the user is reaching out. Null until they choose one. |
| websiteUrl | string | null The website the user gave. Null until they give one. |
| notes | string | null Notes the user wrote. Null until they write any. |
| attachments | object[] Documents the user attached. Empty until they attach any. |
| icp | object | null The ideal customer profile. Null until one is saved. |
| leadIds | string[] Ids of the leads found during onboarding. Empty until any are found. |
| campaignId | string | null The onboarding campaign. Null until it is created. |
| completedAt | string · date-time | null When onboarding was completed. Null until then. |
| requestId | string · uuid Id of this request, for support and troubleshooting |
Errors
- 400: Bad request
- 401: Unauthorized: missing or invalid API key
- 403: Forbidden
- 404: Not found
- 422: Invalid request payload