Remote Integrations API is one of 101 APIs that Remote publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Integrations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
17 operations
across 13 paths,
and defines 43 schemas.
It is described by OpenAPI 3.0.0, at version 0.1.0.
Requests are made against 2 base URLs: https://gateway.remote.com/, https://gateway.remote-sandbox.com/.
The identity and technical contract details declared by the specification.
Remote Integrations 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.
CreateSingleSelectCustomFieldDefinitionParams
object
Schema for creating a single select custom field definition
6 properties
6 required
ParameterError
object
3 properties
3 required
ListEmploymentCustomFieldsResponse
object
Response schema listing many customfields
1 property
SingleSelectMetadata
object
The metadata for a single select custom field
1 property
1 required
SuccessResponse
object
A generic success response returned by operations that don't produce a specific resource (e.g., updates, deletes).
1 property
1 required
WebhookEvent
object
6 properties
6 required
ListEmploymentCustomFieldValuePaginatedResponse
object
Response schema listing many customfieldvalues
1 property
Integrations.Scim.GroupListResponse
object
5 properties
5 required
EmploymentCustomFieldValueResponse
object
Response containing a single custom field value for an employment.
1 property
1 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 property
1 required
CreateWebhookCallbackParams
object
Webhook callback creation params. Provide either subscribedevents or subscribetoallevents: true (they are mutually exclusive).
3 properties
1 required
UnprocessableEntityResponse
object
CurrencyCode
string
Currency code of the SWIFT fee. Only present when processingfee is set.
HelpCenterArticleResponse
object
Help Center Article Response
1 property
1 required
Integrations.Scim.User
object
10 properties
6 required
CreateCurrencyCustomFieldDefinitionParams
object
Schema for creating a currency custom field definition
6 properties
6 required
CustomFieldDataType
string
The datatype of the custom field
EmploymentCustomFieldValue
object
The value of a custom field for a specific employment. The type of value depends on the custom field's data type.
2 properties
2 required
ActionError
object
3 properties
3 required
Integrations.Scim.UserListResponse
object
5 properties
5 required
ListEmploymentCustomFieldValueResponse
object
A custom field value as returned in list responses, including the field definition details alongside the value.
4 properties
4 required
CustomFieldSimpleDataType
string
The datatype of the custom field
WebhookCallback
object
A registered webhook callback endpoint. Remote sends HTTP POST requests to the configured URL when subscribed events occur.
5 properties
2 required
UpdateEmploymentCustomFieldValueParams
object
Schema for updating a custom field value.
1 property
1 required
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 property
1 required
Integrations.Scim.Group
object
5 properties
4 required
NotFoundResponse
object
Returned when the requested resource does not exist or is not accessible with the current authentication credentials.
1 property
CustomFieldVisibilityScope
string
Who can see this custom field and its values. Controls visibility across different user roles.
EmploymentCustomField
object
A custom field definition that can be applied to employments within a company. Custom fields allow you to store additional structured data on employments beyon…
7 properties
7 required
IdsRequiredParams
object
1 property
1 required
CustomFieldDataEntryAccess
string
Who can enter or edit values for this custom field. Controls which users see the field as editable vs read-only.
ReplayWebhookEventsParams
object
Replay webhook events params
CreateCustomFieldDefinitionParams
Schema for creating a custom field definition
Integrations.Scim.ErrorResponse
object
4 properties
3 required
BeforeAfterRequiredParams
object
5 properties
2 required
UpdateWebhookCallbackParams
object
Webhook callback update params. Provide either subscribedevents or subscribetoallevents (they are mutually exclusive). Omitting subscribetoallevents leaves the…
3 properties
WebhookCallbackResponse
object
Webhook callback response
1 property
1 required
ListWebhookCallbacksResponse
object
1 property
1 required
EmploymentCustomFieldValueJsonValue
object
The value for a single-select custom field, containing both the option ID and its human-readable label.
2 properties
2 required
HelpCenterArticle
object
Help Center Article
4 properties
4 required
CreateEmploymentCustomFieldResponse
object
Response returned after successfully creating a new custom field definition.
1 property
1 required
CreateGeneralCustomFieldDefinitionParams
object
Schema for creating a general custom field definition
5 properties
5 required
ListWebhookEventsResponse
object
Response schema listing many webhookevents
1 property
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Remote publishes across the network.
