如何使用 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
  }
}

AI助手

响应是通过人工智能生成的,可能包含错误。

我能帮您什么?

随时问我关于 Blue 或本文档的任何问题。

输入发送 • Shift+Enter 换行 • ⌘I 打开