Company Managers

Create and invite a Company Manager

Create a Company Manager and sends the invitation email for signing in to the Remote Platform.

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:write works too.

Token type	Category	Read only Scope	Write only Scope (read access implicit)
Company-scoped access token	Manage company resources (company_admin)	-	Manage managers (company_manager:write)
Company-scoped access token (assertion)	Manage company resources (company_admin)	-	Manage managers (company_manager:write)
Customer API token	Manage company resources (company_admin)	-	Manage managers (company_manager:write)

post/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:write
- 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:write
- or OAuth 2
  Client credentials
  Token URL: /auth/oauth2/token scopes: all:write
- or HTTP bearer

Query parameters

actionsstring

Complementary action(s) to perform when creating a company manager:

no_invite skips the email invitation step

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.

Request body

company_idstring

The Company ID. Required if the access token can access multiple companies. Optional otherwise.

emailstring email required

The work email of the company manager

namestring required

The name of the company manager

rolestring required

The role assigned for the new manager. The value should be one of the following:

admin: assigns the Super Admin role. A Super Admin has full access to the company on Remote, like the owner.
onboarding_manager: an Onboarding Manager can add, see and manage new hires.
people_manager: a People Manager can view employee profiles of the team members they manage and approve and decline time off and expenses for their employees.

Example request

{
  "email": "john.doe@example.com",
  "name": "John Doe",
  "role": "admin"
}

Response

Success

Example response

{
  "company_manager": {
    "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"
  }
}

Changes

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