# Get onboarding info

### Get onboarding info

`GET /api/v1/onboarding`

Operation ID: `getOnboarding`

Returns what the user told Needle during onboarding and what it produced: the use case, website, notes, attached documents, the ideal customer profile, the ids of the leads found, the onboarding campaign id, and when onboarding was completed. Fields the user has not reached yet are null or empty.

**200**: The onboarding info.

- `intent` ("sales" | "hiring" | "fundraising" | "partnerships" | "events" | "other" | null, required): Why the user is reaching out. Null until they choose one.
- `websiteUrl` (string | null, required): The website the user gave. Null until they give one.
- `notes` (string | null, required): Notes the user wrote. Null until they write any.
- `attachments` (object[], required): Documents the user attached. Empty until they attach any.
- `icp` (object | null, required): The ideal customer profile. Null until one is saved.
- `leadIds` (string[], required): Ids of the leads found during onboarding. Empty until any are found.
- `campaignId` (string | null, required): The onboarding campaign. Null until it is created.
- `completedAt` (string · date-time | null, required): When onboarding was completed. Null until then.
- `requestId` (string · uuid, required): 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