REremote-com
Departments

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 by a company manager through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
  • Company-scoped access token (assertion) (OAuth2CompanyManagerAssertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant for a company manager. See OAuth Assertion.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page, with the scopes they choose there. See Authorization for customers.

Scopes

Any one of the scopes in a token type's row is enough. all:read and all:write work too.

Token typeCategoryRead only ScopeWrite only Scope (read access implicit)
Company-scoped access tokenManage company resources (company_admin)View departments (company_department:read)Manage departments (company_department:write)
Company-scoped access token (assertion)Manage company resources (company_admin)View departments (company_department:read)Manage departments (company_department:write)
Customer API tokenManage 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
    • OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: https://gateway.remote.com/company.manage
    • or OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: company_department:read
    • or OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: all:read
    • or OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: all:write
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: company_department:read
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: all:read
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: all:write
    • or HTTP bearer

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 1 revision of this API.