REremote-com
Company Managers

List Company Managers

List the company managers of the company the access token belongs to.

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 managers (company_manager:read)Manage managers (company_manager:write)
Company-scoped access token (assertion)Manage company resources (company_admin)View managers (company_manager:read)Manage managers (company_manager:write)
Customer API tokenManage company resources (company_admin)View managers (company_manager:read)Manage managers (company_manager:write)
get/v1/company-managers

Request

  • Base URL
    https://gateway.remote.com
  • URL
    https://gateway.remote.com/v1/company-managers
  • 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_manager: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_manager: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

The company the access token belongs to. Optional: the list always holds that company's managers, and any other company fails with "Company not found".

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

An access token of one of the types listed in this endpoint's Authentication section, as Bearer <ACCESS TOKEN>.

A token from the Refresh Token flow is of the same type as the token issued with that refresh token.

Response

Success

Example response

{
  "company_managers": [
    {
      "billing_contacts": [
        {
          "is_pending_primary_billing_contact": false,
          "is_primary_billing_contact": true,
          "legal_entity_slug": "0a8s2d1-legal-entity-slug"
        }
      ],
      "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
}

Changes

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