如何使用 Blue API 根據 ID 或 slug 獲取公司資訊。
要檢索公司資訊,您可以使用 company
查詢,無論是使用公司 ID 還是 slug:
根據公司 ID 查詢
query GetCompanyById {
company(id: "company-id-here") {
id
name
slug
createdAt
updatedAt
}
}
根據公司 Slug 查詢
相同的查詢也接受公司 slug,使得使用 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 和 slug- 只有當前用戶是成員的公司才會被返回
- 如果找不到公司或用戶沒有訪問權限,將會拋出
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
}
}