Sign in

v1

latestOpenAPI 3.1.02026-07-242735131.1 MB
Company Managers

List Company Managers

List all company managers of an integration. If filtered by the company_id param, it lists only company managers belonging to the specified company.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage company resources (company_admin)View managers (company_manager:read)Manage managers (company_manager:write)
get/v1/company-managers

Query parameters

company_idstring

A Company ID to filter the results (only applicable for Integration Partners).

pageinteger

Starts fetching records after the given page

page_sizeinteger

Change the amount of records returned per page, defaults to 20, limited to 100

Headers

Authorizationstring required

Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow.

The refresh token needs to have been obtained through the Authorization Code flow.

Response

Success

Example response

{
  "company_managers": [
    {
      "company_id": "0a8s2d1-company-id-2e3f4th",
      "role": "owner",
      "user_email": "user@example.com",
      "user_id": "983088c9-user-id-023fc08b8625",
      "user_name": "Anne White"
    }
  ],
  "current_page": 1,
  "total_count": 1,
  "total_pages": 1
}