Org Structure

List company structure nodes

Shows all the company structure nodes of an employment.

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 type	Category	Read only Scope	Write only Scope (read access implicit)
Company-scoped access token	Manage company resources (company_admin)	View company structure (company_structure:read)	-
Company-scoped access token (assertion)	Manage company resources (company_admin)	View company structure (company_structure:read)	-
Customer API token	Manage company resources (company_admin)	View company structure (company_structure:read)	-

get/v1/employments/{employment_id}/company-structure-nodes

Request

Base URL
https://gateway.remote.com
URL
https://gateway.remote.com/v1/employments/{employment_id}/company-structure-nodes
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_structure: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_structure: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

Path parameters

employment_idstring required

Employment ID

Response

Success

Example response

{
  "data": {
    "company_structure_nodes": [
      {
        "company_structure": {
          "attributes": {
            "type": "Cost Center"
          },
          "id": "dc022a60-16d0-46c8-8f57-276243168d78",
          "name": "Cost Center"
        },
        "id": "aa9a1cb4-d08d-47d3-82d3-7b90c95ff830",
        "parent": {
          "id": "96f9fb1f-fdae-4d0f-8931-5e168ab9c7fa",
          "name": "BCA Logistics"
        }
      },
      {
        "company_structure": {
          "id": "0162fe80-2fa4-4b2c-87be-6c6a208a9438",
          "name": "Supervisory Org"
        },
        "id": "13d00efe-50b5-466f-b86a-82a685336861",
        "parent": {
          "attributes": {
            "type": "Supervisory Org"
          },
          "id": "7e1dcfd8-8d3a-4aff-b2b7-23eabf88d844",
          "name": "Tokyo"
        }
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.