Companies

List the companies your token can access. This is usually the first call of an integration — the returned id values scope every other query (the <COMPANY_ID> placeholders elsewhere).

Uses listCompanies, a standard paged query: pass page to control the page size, read pageInfo to know when to stop (see Pagination).

Field	Description
id	Company ID, used as companyId in other queries
name	Display name of the company
organization.id	Organization ID, used as organizationId in other queries
organization.name	Name of the organization the company belongs to

query AvailableCompanies {
  listCompanies(page: {limit: 25}) {
    items {
      id
      name
      organization {
        id
        name
      }
    }
    pageInfo {
      totalCount
      hasNextPage
    }
  }
}

Response

{
  "data": {
    "listCompanies": {
      "items": [
        {
          "id": "uuid",
          "name": "Company",
          "organization": {
            "id": "uuid",
            "name": "Organization"
          }
        }
      ]
    }
  }
}