Blue APIを使用してIDまたはスラグで会社情報を取得する方法。
会社情報を取得するには、会社IDまたはスラグを使用してcompany
クエリを使用できます:
会社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
}
}