---
title: "The onboarding instruction for this account [read]"
method: GET
path: "/partner/onboarding"
tags: ["partner"]
---

# The onboarding instruction for this account \[read\]

`GET /partner/onboarding`

## Request

- Base URL: `https://api.agentsky.dev/v1`
- URL: `https://api.agentsky.dev/v1/partner/onboarding`
- Auth: HTTP bearer

Markdown by default (the reader is a language model); `?format=json` returns the same state as fields. It describes the step this account is actually on, so an agent can fetch it, make the call it names, and fetch it again until it reports the account is live. This is the entry point for white-label onboarding — there is no form.

## Query parameters

- `format` 'markdown' | 'json'

## Response `200`

The instruction

- PartnerState
  - `state` 'unapplied' | 'waiting' | 'rejected' | 'setting_up' | 'live' | 'suspended'
  - `next_action` string, nullable: The one call that advances onboarding; null when nothing does.
  - `outstanding` string[]
  - `partner` Partner
    - `id` string
    - `slug` string
    - `name` string
    - `status` 'pending' | 'active' | 'suspended'
    - `key_prefix` string, nullable: Null until claimed.
    - `brand` object
    - `brand_missing` string[]: Brand fields still falling back to ours.
    - `rate_limit_per_min` integer, nullable
    - `hostname_quota` integer
    - `hostnames` PartnerHostname[]
      - `hostname` string
      - `plane` 'API' | 'GATEWAY' | 'APP' | 'ACCOUNTS' | 'STUDIO_POOL' | 'STUDIO_WILDCARD'
      - `ssl_status` string
      - `serving` boolean: Only a serving hostname counts toward going live.

## Other responses

- `default`: Error — { error: { code, message } }

## Changes

- **2026-11-02** `e5e8f0229a99`: 1 info
  - added the optional property `error/request_id` to the response with the `default` status

[Operation history](https://skmtc.dev/agentsky/apis/agentsky-developer-api/changes/partner/onboarding/get.md)

---

[API](https://skmtc.dev/agentsky/apis/agentsky-developer-api.md) - [All operations](https://skmtc.dev/agentsky/apis/agentsky-developer-api/llms.txt) - [OpenAPI document](https://skmtc.dev/agentsky/apis/agentsky-developer-api/revisions/8280a065ef6a?raw)