> ## Documentation Index
> Fetch the complete documentation index at: https://docs.punchrescue.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get partner onboarding progress

> **Required permission:** `read`. **Key scope:** the partner's own key (not narrowed
to specific orgs) or a global key.

Returns the partner's own onboarding-checklist progress, same shape as
`GET /orgs/{orgId}/onboarding`: overall `percent`, `completed`/`total`, and
per-step completion grouped with labels. The same view the partner portal's
"Get started" panel and the `get_partner_onboarding_progress` MCP tool return.



## OpenAPI

````yaml https://api.rescue-serverless.dev.back2back.team/api/public/v1/openapi.json get /partners/{partner_id}/onboarding
openapi: 3.1.0
info:
  title: Rescue Public API v1
  description: >-
    Stable public API for partner integrations.


    **Authentication:** `Authorization: Bearer rk_live_<8 hex><64 hex>`. Tokens
    are minted via `POST /api/v1/api-keys` (internal admin) and shown exactly
    once at creation. The same plaintext is required for every public-v1 request
    — store it securely.


    **Permissions:** v1 vocabulary is `read` | `write`. Future versions may
    introduce granular `<resource>:<action>` permissions additively.


    **Idempotency:** retries on a 5xx must be assumed to have unknown outcomes —
    check `GET /emergencies/{id}` (optionally via `externalId`) before retrying.
    An `Idempotency-Key` header will be supported in a future revision.


    **Webhook delivery:** payloads may be duplicated and out-of-order. Dedup on
    `eventId`; order events per emergency on `(emergencyId, sequence)`.
  version: 1.0.0
servers:
  - url: https://api.punchrescue.com/api/public/v1
security:
  - BearerAuth: []
paths:
  /partners/{partner_id}/onboarding:
    get:
      tags:
        - Onboarding
      summary: Get partner onboarding progress
      description: >-
        **Required permission:** `read`. **Key scope:** the partner's own key
        (not narrowed

        to specific orgs) or a global key.


        Returns the partner's own onboarding-checklist progress, same shape as

        `GET /orgs/{orgId}/onboarding`: overall `percent`, `completed`/`total`,
        and

        per-step completion grouped with labels. The same view the partner
        portal's

        "Get started" panel and the `get_partner_onboarding_progress` MCP tool
        return.
      operationId: partnerOnboarding.get
      parameters:
        - name: partner_id
          in: path
          required: true
          schema:
            type: string
            description: Target partner id (from the route path)
            title: Partner Id
          description: Target partner id (from the route path)
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PartnerOnboardingProgressResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    PartnerOnboardingProgressResponse:
      properties:
        status:
          type: string
          title: Status
        completed:
          type: integer
          title: Completed
        total:
          type: integer
          title: Total
        percent:
          type: integer
          title: Percent
        groups:
          items:
            $ref: '#/components/schemas/OnboardingProgressGroup'
          type: array
          title: Groups
      type: object
      required:
        - status
        - completed
        - total
        - percent
        - groups
      title: PartnerOnboardingProgressResponse
      description: >-
        Partner-track onboarding progress for the public endpoint and the MCP
        tool (same shape as the org one).
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    OnboardingProgressGroup:
      properties:
        label:
          type: string
          title: Label
        steps:
          items:
            $ref: '#/components/schemas/OnboardingProgressStep'
          type: array
          title: Steps
      type: object
      required:
        - label
        - steps
      title: OnboardingProgressGroup
      description: A labeled group of onboarding progress steps, in catalog display order.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
    OnboardingProgressStep:
      properties:
        key:
          type: string
          title: Key
        label:
          type: string
          title: Label
        done:
          type: boolean
          title: Done
        requires:
          anyOf:
            - type: string
            - type: 'null'
          title: Requires
      type: object
      required:
        - key
        - label
        - done
      title: OnboardingProgressStep
      description: >-
        One applicable onboarding step rendered for the public/MCP progress
        view.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: rk_live_<8hex><64hex>

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.