Como recuperar informações da empresa usando ID ou slug com a API Blue.


Para recuperar informações da empresa, você pode usar a company consulta com o ID ou slug da empresa:

Consulta por ID da Empresa

query GetCompanyById {
  company(id: "company-id-here") {
    id
    name
    slug
    createdAt
    updatedAt
  }
}

Consulta por Slug da Empresa

A mesma consulta também aceita um slug da empresa, facilitando a recuperação das informações da empresa usando o identificador amigável para URL:

query GetCompanyBySlug {
  company(id: "company-slug-here") {
    id
    name
    slug
    createdAt
    updatedAt
  }
}

Exemplo de Resposta

Ambas as consultas retornarão o mesmo objeto de empresa:

{
  "data": {
    "company": {
      "id": "cuid123456789",
      "name": "Acme Corporation",
      "slug": "acme-corp",
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-03-20T14:45:00.000Z"
    }
  }
}

Notas Importantes

  • O id parâmetro aceita tanto IDs quanto slugs de empresas
  • Apenas empresas onde o usuário atual é um membro serão retornadas
  • Se a empresa não for encontrada ou o usuário não tiver acesso, um CompanyNotFoundError será lançado
  • Empresas banidas lançarão um CompanyBannedError

Campos Disponíveis

Você pode consultar campos adicionais da empresa conforme necessário:

query GetCompanyDetails {
  company(id: "company-slug") {
    id
    name
    slug
    # Add more fields as needed based on your requirements
    # Check the GraphQL schema for all available fields
  }
}

Assistente de IA

As respostas são geradas usando IA e podem conter erros.

Como posso ajudá-lo?

Pergunte-me qualquer coisa sobre o Blue ou esta documentação.

Digite para enviar • Shift+Enter para nova linha • ⌘I para abrir