> ## Documentation Index > Fetch the complete documentation index at: https://docs.launchpointhq.com/llms.txt > Use this file to discover all available pages before exploring further. # Get a creator's onboarding > Everything one approved creator still needs in a program, as the dashboard's Onboarding task shows it. It also answers for a creator with no linked account or no proof. Approving a proof meets one requirement. Onboarding is finished when nothing is left: `status` is `ready`. `status` matches the dashboard: a creator in the Onboarding list has its status there; any other creator is `ready`, or `getting_ready` while they still cannot post (for example, no linked account). ## OpenAPI ````yaml /api-reference/openapi.json get /onboarding/{creatorId} openapi: 3.0.4 info: title: Launchpoint Public API version: 1.0.0 description: >- **Private preview.** The Launchpoint Public API is in private preview and available only to trusted partners we work with directly. Access is not self-serve. Email hi@launchpointhq.com to ask about access. REST API for Launchpoint brands and agencies. Use an API key in the `x-api-key` header to authenticate. ## Requirements - Public API access must be enabled for the company. During private preview, access is limited to trusted partners. - Create and manage API keys in Dashboard → Settings → Developer. ## Creator privacy - Responses never include creator email addresses. Creator phone numbers are null when no number is stored or the workspace does not have access to creator contact details. ## Rate limits - Default: **100 requests per minute** per API key. - Approved partner accounts: **400 requests per minute**. - Every response includes `X-RateLimit-Limit`, `X-RateLimit-Remaining`, and `X-RateLimit-Reset`. Requests over the limit return `429`. ## Errors - Errors use `{ "error": "" }` with the matching HTTP status. Some endpoints also include a `code`. ## Timestamps - Timestamps are Unix timestamps in milliseconds unless a field says otherwise. ## Pagination - Most list endpoints accept `page` and `limit` and return `{ data, page, total }`. Some also return `totalPages`. - `scope=company` is the default. A parent agency key can pass `scope=agency` on supported routes to include its own data and linked brands. servers: - url: https://dashboard.launchpointhq.com/api/v1 description: Live API server security: - apiKeyAuth: [] tags: - name: Deals description: Public creator opportunities across Launchpoint - name: Programs description: Programs and campaign management - name: Posts description: Posts and social content - name: Analytics description: KPIs and performance metrics - name: Payouts description: Payouts, balances, and pending creator funds - name: Contracts description: Contracts and creator agreements - name: Creators description: Creator profiles and metrics - name: Applications description: Creator applications to Canvas programs - name: Messages description: Read and send creator messages - name: Onboarding description: 'Creator onboarding: status, messages, and proof review' - name: Media review description: >- Review the media creators send before they post: queue, status, approve, and reject paths: /onboarding/{creatorId}: get: tags: - Onboarding summary: Get a creator's onboarding description: >- Everything one approved creator still needs in a program, as the dashboard's Onboarding task shows it. It also answers for a creator with no linked account or no proof. Approving a proof meets one requirement. Onboarding is finished when nothing is left: `status` is `ready`. `status` matches the dashboard: a creator in the Onboarding list has its status there; any other creator is `ready`, or `getting_ready` while they still cannot post (for example, no linked account). parameters: - $ref: '#/components/parameters/ScopeParam' - in: path name: creatorId required: true schema: type: string description: Opaque creator id returned by `/creators` - in: query name: programId required: true schema: type: string format: uuid responses: '200': description: Creator onboarding returned successfully content: application/json: schema: type: object required: - programId - creatorId - status - canPost - pendingProofCount - requiredPlatforms - missingPlatforms - warmUp - accounts - requirementsWithoutAccount - checklist properties: programId: type: string format: uuid creatorId: type: string status: type: string enum: - waiting_for_review - getting_ready - ready description: >- `waiting_for_review`: a proof waits for your decision. `getting_ready`: the creator still has to do something. `ready`: nothing is left (detail only). canPost: type: boolean description: The creator may post in the program now pendingProofCount: type: integer requiredPlatforms: type: array items: type: string description: Platforms the program requires an account on missingPlatforms: type: array items: type: string description: Required platforms without a ready account warmUp: type: object required: - required - status properties: required: type: boolean status: type: string enum: - unavailable - not_required - waiting_for_account - not_started - in_progress - pending_review - rejected - complete accounts: type: array description: The creator's accounts linked to the program items: type: object required: - platform - username - met - requirements properties: platform: type: string username: type: string nullable: true description: >- Null while creator details are locked for the workspace met: type: boolean description: Every requirement on this account is met requirements: type: array items: type: object required: - id - type - label - instructions - status - unmetReason - rejectionComments - pendingProofId properties: id: type: string type: type: string enum: - account_requirement - warm_up label: type: string instructions: type: string status: type: string enum: - met - not_applicable - unmet - checking - pending_review - rejected unmetReason: type: string nullable: true description: >- Why an automatic check is unmet, for example `bio_link_missing` rejectionComments: type: string nullable: true description: Your message on the latest rejected proof pendingProofId: type: string format: uuid nullable: true description: >- Set while a proof waits. Approve or reject it with the onboarding proof endpoints. requirementsWithoutAccount: type: array description: >- Custom requirements the creator cannot meet yet because no linked account is on their platforms items: type: object required: - id - label - instructions - platforms properties: id: type: string label: type: string instructions: type: string platforms: type: array items: type: string checklist: type: array description: The program's onboarding checklist items for the creator items: type: object required: - label - platform - result - manual properties: label: type: string platform: type: string nullable: true result: type: string enum: - met - unmet - unknown manual: type: boolean description: Your team ticks it in the dashboard '400': description: Invalid program or creator id '403': description: The program is read-only for this API key '404': description: Program not found, or the creator is not approved in the program components: parameters: ScopeParam: in: query name: scope required: false schema: type: string enum: - company - agency default: company description: >- Choose the data scope. `company` (default) limits results to the API key company's data. `agency` includes the parent agency and its linked brands. `scope=agency` requires a parent agency key; other keys receive `403`. securitySchemes: apiKeyAuth: type: apiKey in: header name: x-api-key description: API key created in Dashboard → Settings → Developer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.