# Configurações do whitelabel

Retorna as configurações do whitelabel incluindo informações da empresa, contatos, cores, conteúdos e outras configurações visuais.

Endpoint: GET /api/v3/whitelabel/settings
Version: 3.0.0
Security: OAuth2

## Header parameters:

  - `CPlug-Company-Id` (number, required)
    Id da Empresa (Company).

Você pode localizar os IDs das empresas no _endpoint_ de listagem de empresas.
    Example: 12

## Response 200 fields (application/json):

  - `data` (object)
    Configurações do whitelabel

  - `data.id` (integer, required)
    ID único das configurações do whitelabel
    Example: 2

  - `data.legal_name` (string, required)
    Razão social da empresa
    Example: "praesentium"

  - `data.trade_name` (string, required)
    Nome fantasia da empresa
    Example: "eum"

  - `data.website` (string)
    Website da empresa
    Example: "https://cplug.com.br"

  - `data.cnpj` (string, required)
    CNPJ da empresa
    Example: "81386555596405"

  - `data.type` (string, required)
    Tipo da configuração
    Example: "whitelabel"

  - `data.url` (string, required)
    URL do whitelabel
    Example: "test.cplug.com.br"

  - `data.contacts` (array, required)
    Lista de contatos da empresa

  - `data.contacts.id` (integer, required)
    ID único do contato
    Example: 11

  - `data.contacts.reseller_id` (integer, required)
    ID do revendedor
    Example: 2

  - `data.contacts.external_id` (integer, required)
    ID externo do contato
    Example: 2

  - `data.contacts.name` (string, required)
    Nome do contato
    Example: "Contato"

  - `data.contacts.created_at` (string)
    Data de criação do contato
    Example: "2025-05-27T19:33:45.000000Z"

  - `data.contacts.updated_at` (string)
    Data de atualização do contato
    Example: "2025-05-27T19:33:45.000000Z"

  - `data.contacts.deleted_at` (string)
    Data de exclusão do contato
    Example: "2025-05-27T19:33:45.000000Z"

  - `data.contacts.support` (boolean, required)
    Indica se é um contato de suporte

  - `data.contacts.financial` (boolean, required)
    Indica se é um contato financeiro

  - `data.contacts.emails` (array, required)
    Lista de emails do contato

  - `data.contacts.emails.id` (integer, required)
    ID único do email
    Example: 10

  - `data.contacts.emails.contact_id` (integer, required)
    ID do contato associado
    Example: 11

  - `data.contacts.emails.email` (string, required)
    Endereço de email
    Example: "contato@cplug.com.br"

  - `data.contacts.emails.created_at` (string)
    Data de criação do email
    Example: "2025-05-27T19:33:45.000000Z"

  - `data.contacts.emails.updated_at` (string)
    Data de atualização do email
    Example: "2025-05-27T19:33:45.000000Z"

  - `data.contacts.emails.deleted_at` (string)
    Data de exclusão do email
    Example: "2025-05-27T19:33:45.000000Z"

  - `data.contacts.phones` (array, required)
    Lista de telefones do contato

  - `data.contacts.phones.id` (integer, required)
    ID único do telefone
    Example: 10

  - `data.contacts.phones.phone` (string, required)
    Número de telefone
    Example: "11999999999"

  - `data.contacts.phones.created_at` (string)
    Data de criação do telefone
    Example: "2025-05-27T19:33:45.000000Z"

  - `data.contacts.phones.updated_at` (string)
    Data de atualização do telefone
    Example: "2025-05-27T19:33:45.000000Z"

  - `data.contacts.phones.deleted_at` (string)
    Data de exclusão do telefone
    Example: "2025-05-27T19:33:45.000000Z"

  - `data.address` (string, required)
    Endereço completo da empresa
    Example: "Rua Itapaiuna, 2434 - CPlug<br>Jardim Morumbi - São Paulo/SP"

  - `data.logo` (string, required)
    URL do logo da empresa
    Example: "https://cplug.com.br/logo.png"

  - `data.favicon` (string, required)
    URL do favicon da empresa
    Example: "https://cplug.com.br/favicon.ico"

  - `data.colors` (object, required)
    Configurações de cores do whitelabel

  - `data.colors.navigation_background` (string, required)
    Cor de fundo da navegação
    Example: "#000000"

  - `data.colors.navigation_text` (string, required)
    Cor do texto da navegação
    Example: "#FFFFFF"

  - `data.colors.menu_background` (string, required)
    Cor de fundo do menu
    Example: "#333333"

  - `data.colors.menu_text` (string, required)
    Cor do texto do menu
    Example: "menu texto"

  - `data.colors.highlight_background` (string, required)
    Cor de fundo de destaque
    Example: "#FF0000"

  - `data.colors.highlight_text` (string, required)
    Cor do texto de destaque
    Example: "#FFFFFF"

  - `data.contents` (array, required)
    Lista de conteúdos do whitelabel

  - `data.contents.id` (integer, required)
    ID único do conteúdo
    Example: 55

  - `data.contents.external_id` (integer, required)
    ID externo do conteúdo
    Example: 2

  - `data.contents.title` (string, required)
    Título do conteúdo
    Example: "Conteúdo"

  - `data.contents.description` (string, required)
    Descrição do conteúdo
    Example: "Descrição do conteúdo"

  - `data.contents.content_type` (integer, required)
    Tipo do conteúdo
    Example: 3

  - `data.contents.created_at` (string)
    Data de criação do conteúdo
    Example: "2025-05-27T19:33:45.000000Z"

  - `data.contents.updated_at` (string)
    Data de atualização do conteúdo
    Example: "2025-05-27T19:33:45.000000Z"

  - `data.contents.deleted_at` (string)
    Data de exclusão do conteúdo
    Example: "2025-05-27T19:33:45.000000Z"

  - `data.footer_columns` (integer, required)
    Número de colunas do rodapé
    Example: 12

## Response 400 fields (application/json):

  - `code` (string, required)
    Código de erro.
    Example: "missing_headers"

  - `message` (string)
    Descrição do erro.
    Example: "error message"

  - `meta` (array)
    Dados adicionais sobre o erro.

## Response 422 fields (application/json):

  - `code` (string, required)
    Código de erro.
    Example: "uneditable_entity"

  - `message` (string)
    Descrição do erro.
    Example: "description error"

  - `meta` (array)
    Dados adicionais sobre o erro.

  - `meta.field` (string, required)
    Nome do campo no qual existe um erro de validação.
    Example: "name"

  - `meta.validations` (array)

  - `meta.validations.type` (string, required)
    Tipo da validação aplicada.
    Example: "Required"

  - `meta.validations.value` (array)
    Tipo de valor aplicável (esse campo pode ser vazio).


## Response 401 fields

## Response 404 fields