Skip to content

Empresas

Endpoints para consulta de empresas vinculadas ao token de integração.

Listar Empresas

GET /api/companies

Retorna uma lista de empresas associadas ao token do usuário.

Casos de uso:

  • Obter IDs de empresas para filtros
  • Validar acesso a empresas específicas
  • Popular seletores de empresa em integrações

Exemplo de Requisição

bash
curl -X GET "https://api-b2s.experienciab2s.com/api/companies" \
     -H "Authorization: Bearer SEU_TOKEN"

Resposta de Sucesso (200)

json
[
  { "id": "103a525c-0ce3-4182-a504-aad595425233", "name": "Empresa 1" },
  { "id": "203a525c-0ce3-4182-a504-aad595425233", "name": "Empresa 2" },
  { "id": "303a525c-0ce3-4182-a504-aad595425233", "name": "Empresa 3" }
]

Estrutura da Resposta

CampoTipoDescrição
idstringID único da empresa (UUID)
namestringNome da empresa

Códigos de Resposta

CódigoDescrição
200Empresas encontradas
401Token ausente ou inválido
403Token inválido ou usuário não autorizado
404Token de integração não encontrado

Integration Documentation