List Company Departments

Lists all departments for the authorized company specified in the request.

Authentication

This endpoint accepts any one of the following token types:

Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page. See Authorization for customers.

Scopes

Category	Read only Scope	Write only Scope (read access implicit)
Manage company resources (company_admin)	View departments (company_department:read)	Manage departments (company_department:write)

get/v1/company-departments

Request

Base URL: https://gateway.remote.com
URL: https://gateway.remote.com/v1/company-departments
Auth: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, company_department:read, company_department:write, company_admin, all:write, all:read)

Query parameters

company_idstring required

Company ID

paginateboolean

Paginate option. Default: true. When true, paginates response; otherwise, does not.

pageinteger

Starts fetching records after the given page

page_sizeinteger

Number of items per page

Response

Success

current_pageinteger required

total_countinteger required

total_pagesinteger required

Example response

{
  "current_page": 1,
  "data": {
    "company_departments": [
      {
        "company_id": "669f9e18-889f-4c2c-95b8-67795a3113cc",
        "id": "89c4fbb2-cd1f-4334-8e4b-280f8795bbd8",
        "name": "Marketing"
      }
    ]
  },
  "total_count": 1,
  "total_pages": 1
}

Changes

No recorded changes to this operation across all 65 revisions of this API.