Remote Companies API declares
7 security schemes
for authenticating requests.
It accepts HTTP basic authentication (BasicAuth).
It accepts HTTP bearer tokens (ClientToken).
It accepts HTTP bearer tokens (CustomerAPIToken).
It supports OAuth 2.0 (OAuth2) using the authorizationCode and clientCredentials flows, exposing 77 scopes.
It supports OAuth 2.0 (OAuth2Assertion) using the clientCredentials flow, exposing 21 scopes.
It supports OAuth 2.0 (OAuth2AuthorizationCode) using the authorizationCode flow, exposing 73 scopes.
It supports OAuth 2.0 (OAuth2ClientCredentials) using the clientCredentials flow, exposing 18 scopes.
By default, every request must be authenticated.
BasicAuth — Authenticate using the basic authentication for partners. Use the CLIENTID as login and CLIENTSECRET as password.
ClientToken — Authenticate a partner using only the the provided clienttoken. This authentication method only allows accessing marketing endpoints.
CustomerAPIToken — Authenticate using API Key generated by the customer in their Integration Settings page.
OAuth2 — Authenticate using OAuth 2.0 protocol.
OAuth2Assertion — Authenticate as the employee using the urn:ietf:params:oauth:grant-type:jwt-bearer grant in the OAuth2 protocol.
OAuth2AuthorizationCode — Authenticate as the token authorizer using authorizationcode / refreshtoken grants in the OAuth 2.0 protocol.
OAuth2ClientCredentials — Authenticate using clientcredentials grant in the OAuth 2.0 protocol.
Paths & Operations 21
Across 14 paths, the API surfaces 21 operations — 1 DELETE, 14 GET, 1 PATCH, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
The contract defines 50 schemas that model the data the API accepts and returns. The most detailed are Company (18 properties), CreateCompanyParams (13 properties), UpdateCompanyParams (8 properties), CompanyManager (5 properties). Each schema is shown below with its type and property counts.
ParameterError
object
3 properties3 required
CompanyManagersResponse
object
Response schema listing many companymanagers
1 property
CompanyNotEligibleForCreationErrorResponse
object
Error returned when the company already have employees in countries supported by the integration.
4 properties
CreateCompanyDepartmentParams
object
2 properties2 required
ListCompanyDepartmentsPaginatedResponse
object
4 properties4 required
CompanyWithTokensResponse
object
Shows a company with its refresh and access tokens. Please contact Remote if you need the tokens when creating a company.
2 properties
CompanyLegalEntity
object
5 properties3 required
RefreshTokenResponse
object
CompanyActionsResponse
object
Lists a company's pending actions
1 property1 required
SuccessResponse
object
A generic success response returned by operations that don't produce a specific resource (e.g., updates, deletes).
1 property1 required
ConflictResponse
object
Returned when the request conflicts with the current state of a resource (HTTP 409). For example, trying to create a resource that already exists or performing…
1 property
CompanyDepartmentCreatedResponse
object
1 property
CompanyManager
object
5 properties5 required
UnauthorizedResponse
object
Returned when the request does not include valid authentication credentials. Ensure you are passing a valid OAuth2 access token or API token in the Authorizati…
1 property1 required
CompanyCreationConflictErrorResponse
object
1 property
UnprocessableEntityResponse
object
CompanyManagerData
object
1 property1 required
CompanyAction
object
A pending company-level action (e.g. for Contractor Management Review-step banners).
3 properties2 required
BadRequestResponse
object
Returned when the request is malformed or contains invalid parameters. The message may be a simple string or a structured object with a code and detailed messa…
ActionError
object
3 properties3 required
OnboardingReservesStatus
object
2 properties2 required
CompanyDepartment
object
3 properties3 required
ClientCredentialsResponse
object
BaseTokenResponse
object
3 properties
ForbiddenResponse
object
Returned when the authenticated user or token does not have permission to perform the requested action. Check that the token has the required OAuth2 scopes and…
1 property1 required
NotFoundResponse
object
Returned when the requested resource does not exist or is not accessible with the current authentication credentials.
1 property
CompanyAlreadyExistsErrorResponse
object
Error returned when a company with matching criteria already exists
4 properties
CompanyCreationResponse
object
1 property
CompanyFormResponse
object
Object with required and optional fields, its descriptions and suggested presentation
1 property
CompanyManagerParams
object
4 properties3 required
CompanyStructureNodesResponse
object
1 property1 required
UuidSlug
string
Identifier of the employment being terminated.
AdministrativeDetailsParams
object
2 properties2 required
CompanyComplianceProfile
object
2 properties2 required
OAuth2Tokens
object
CompaniesResponse
object
Shows a list of companies
1 property
CreateCompanyParams
object
13 properties6 required
CompanyCurrency
object
A currency available for use by a company on the Remote platform.
2 properties2 required
CompanyResponse
object
Shows a company
1 property1 required
AuthorizationCodeResponse
object
CompanyStructureNode
object
4 properties1 required
OnboardingReservesStatusResponse
object
1 property1 required
UpdateCompanyParams
object
8 properties
ListCompanyLegalEntitiesResponse
object
Response schema listing many legalentities
1 property
CompanyManagerResponse
object
1 property1 required
ContractorEligibilityResponse
object
1 property1 required
CompanyComplianceProfileResponse
object
1 property
TooManyRequestsResponse
object
Returned when the API rate limit has been exceeded (HTTP 429). Wait before retrying. Check the Retry-After response header for the recommended wait time.
1 property
Company
object
18 properties12 required
CompanyCurrenciesResponse
object
Company currencies
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
