> ## 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.

# List creators in onboarding

> List the creators in one program who still have onboarding work, the same list as the dashboard's Onboarding tasks: creators with a proof waiting for review first, then creators still getting ready.

The list includes approved creators who still have an open slot. A creator with no linked account is listed only when the program requires specific platforms; check other creators with `GET /onboarding/{creatorId}`.



## OpenAPI

````yaml /api-reference/openapi.json get /onboarding
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": "<message>" }` 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:
    get:
      tags:
        - Onboarding
      summary: List creators in onboarding
      description: >-
        List the creators in one program who still have onboarding work, the
        same list as the dashboard's Onboarding tasks: creators with a proof
        waiting for review first, then creators still getting ready.


        The list includes approved creators who still have an open slot. A
        creator with no linked account is listed only when the program requires
        specific platforms; check other creators with `GET
        /onboarding/{creatorId}`.
      parameters:
        - $ref: '#/components/parameters/ScopeParam'
        - in: query
          name: programId
          required: true
          schema:
            type: string
            format: uuid
        - in: query
          name: creatorId
          schema:
            type: string
          description: Optional opaque creator id
        - in: query
          name: page
          schema:
            type: integer
            minimum: 1
            default: 1
        - in: query
          name: limit
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
      responses:
        '200':
          description: Creators returned successfully
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                  - page
                  - total
                  - totalPages
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      required:
                        - programId
                        - creatorId
                        - status
                        - pendingProofCount
                        - lastActivityAt
                      properties:
                        programId:
                          type: string
                          format: uuid
                        creatorId:
                          type: string
                        status:
                          type: string
                          enum:
                            - waiting_for_review
                            - getting_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).
                        pendingProofCount:
                          type: integer
                          description: Proofs waiting for your decision
                        lastActivityAt:
                          type: integer
                          format: int64
                          description: Newest proof submission or account link
                  page:
                    type: integer
                  total:
                    type: integer
                  totalPages:
                    type: integer
        '400':
          description: Invalid program, creator, or paging value
        '404':
          description: Program not found
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.