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

# Read tenant branding

> Returns the connect page's (/connect/<token>) branding/white-label: logo, colors, title/subtitle, support link and the white-label toggle. Requires a tenant-scoped API key — number-scoped keys get 403 (NUMBER_SCOPE_NOT_ALLOWED).

**Requires a tenant-scoped key.**



## OpenAPI

````yaml openapi.json GET /v1/branding
openapi: 3.1.0
info:
  title: Pilot Status API
  version: 1.0.0
  license:
    name: Pilot Status Terms of Service
    url: https://pilotstatus.com.br/terms
  description: >-
    Public REST API for Pilot Status. Authenticate with the `x-api-key: ps_...`
    header (or `x-api-key-id`). Base URL: https://pilotstatus.com.br
servers:
  - url: https://pilotstatus.com.br
security:
  - apiKey: []
  - apiKeyId: []
paths:
  /v1/branding:
    get:
      tags:
        - Branding
      summary: Read tenant branding
      description: >-
        Returns the connect page's (/connect/<token>) branding/white-label:
        logo, colors, title/subtitle, support link and the white-label toggle.
        Requires a tenant-scoped API key — number-scoped keys get 403
        (NUMBER_SCOPE_NOT_ALLOWED).


        **Requires a tenant-scoped key.**
      operationId: get_branding
      responses:
        '200':
          description: Current branding
          content:
            application/json:
              example:
                branding:
                  logoUrl: null
                  primaryColor: '#1fd286'
                  backgroundColor: null
                  companyName: Acme
                  subtitle: null
                  supportUrl: null
                  defaultRedirectUrl: null
                  hidePilotStatusBranding: true
        '401':
          description: Missing or invalid `x-api-key` / `x-api-key-id` header
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Unauthorized
        '403':
          description: Number-scoped key used on a tenant-only endpoint
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Number-scoped keys cannot call tenant endpoints
                code: NUMBER_SCOPE_NOT_ALLOWED
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Too many requests
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Your ps_ API key
    apiKeyId:
      type: apiKey
      in: header
      name: x-api-key-id
      description: API key id (alternative to x-api-key)

````