v1

latestOpenAPI 3.1.02026-07-242735131.1 MB
Company Managers

Create and invite a Company Manager

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

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage company resources (company_admin)-Manage managers (company_manager:write)
post/v1/company-managers

Query parameters

actionsstring

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

  • no_invite skips the email invitation step

Headers

Authorizationstring required

Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow.

The refresh token needs to have been obtained through the Authorization Code flow.

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: an Admin can manage most of the resources in remote.
  • 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": {
    "company_id": "0a8s2d1-company-id-2e3f4th",
    "role": "owner",
    "user_email": "user@example.com",
    "user_id": "983088c9-user-id-023fc08b8625",
    "user_name": "Anne White"
  }
}