Как получить информацию о компании по ID или слагу с помощью Blue API.
Чтобы получить информацию о компании, вы можете использовать запрос company
с использованием либо ID компании, либо слага:
Запрос по ID компании
query GetCompanyById {
company(id: "company-id-here") {
id
name
slug
createdAt
updatedAt
}
}
Запрос по слагу компании
Тот же запрос также принимает слаг компании, что упрощает получение информации о компании с использованием удобного для URL идентификатора:
query GetCompanyBySlug {
company(id: "company-slug-here") {
id
name
slug
createdAt
updatedAt
}
}
Пример ответа
Оба запроса вернут один и тот же объект компании:
{
"data": {
"company": {
"id": "cuid123456789",
"name": "Acme Corporation",
"slug": "acme-corp",
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-03-20T14:45:00.000Z"
}
}
}
Важные заметки
- Параметр
id
принимает как ID компаний, так и слаги - Будут возвращены только компании, в которых текущий пользователь является участником
- Если компания не найдена или у пользователя нет доступа, будет выброшено
CompanyNotFoundError
- Заблокированные компании вызовут
CompanyBannedError
Доступные поля
Вы можете запрашивать дополнительные поля компании по мере необходимости:
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
}
}