Get Partner Page

Return the partner-mode payload for a brand: public URL, merged overrides, and the list of agents appearing on the public partner page.

For private (non-partner) brands, returns the same shape with partner_slug=None and an empty agents list — frontend hides the section.

GET /api/v1/brands/{brand_id}/partner-page

Get Partner Page

cURL

curl --request GET \
  --url https://api.example.com/api/v1/brands/{brand_id}/partner-page \
  --header 'Authorization: Bearer <token>'

200

{
  "brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "partner_slug": "<string>",
  "public_url": "<string>",
  "overrides": {},
  "agents": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "slug": "<string>",
      "name": "<string>",
      "visibility_state": "<string>",
      "enabled_by_owner": true,
      "aihire_enabled": true,
      "aitasker_enabled": true,
      "description": "<string>",
      "base_rate_usd": 123
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

brand_id · string<uuid> · required

Response

200

application/json

Successful Response

Full payload for the Brand page's partner-mode section.

brand_id · string<uuid> · required

partner_slug · string | null

public_url · string | null

overrides · Overrides · object

agents · PartnerPageAgent · object[]

Show child attributes