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

# Ler a marca do tenant

> Retorna a marca/white-label da página de conexão (/connect/<token>): logo, cores, título/subtítulo, link de suporte e toggle de white-label. Requer uma API key tenant-scoped — keys por número recebem 403 (NUMBER_SCOPE_NOT_ALLOWED).

**Requer uma chave com escopo de tenant.**



## OpenAPI

````yaml openapi.pt.json GET /v1/branding
openapi: 3.1.0
info:
  title: API Pilot Status
  version: 1.0.0
  license:
    name: Pilot Status Terms of Service
    url: https://pilotstatus.com.br/terms
  description: >-
    API REST pública do Pilot Status. Autentique com o header `x-api-key:
    ps_...` (ou `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: Ler a marca do tenant
      description: >-
        Retorna a marca/white-label da página de conexão (/connect/<token>):
        logo, cores, título/subtítulo, link de suporte e toggle de white-label.
        Requer uma API key tenant-scoped — keys por número recebem 403
        (NUMBER_SCOPE_NOT_ALLOWED).


        **Requer uma chave com escopo de tenant.**
      operationId: get_branding
      responses:
        '200':
          description: Marca atual
          content:
            application/json:
              example:
                branding:
                  logoUrl: null
                  primaryColor: '#1fd286'
                  backgroundColor: null
                  companyName: Acme
                  subtitle: null
                  supportUrl: null
                  defaultRedirectUrl: null
                  hidePilotStatusBranding: true
        '401':
          description: Header `x-api-key` / `x-api-key-id` ausente ou inválido
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Unauthorized
        '403':
          description: Chave com escopo de número usada em endpoint exclusivo de tenant
          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: Limite de taxa excedido
          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: Sua chave de API ps_
    apiKeyId:
      type: apiKey
      in: header
      name: x-api-key-id
      description: Id da chave de API (alternativa ao x-api-key)

````