Remote Integrations API
The Integrations API from Remote — 13 operation(s) for integrations.
OpenAPI Specification
openapi: 3.0.0
info:
title: Remote Address Details Integrations API
version: 0.1.0
servers:
- url: https://gateway.remote.com/
variables: {}
- url: https://gateway.remote-sandbox.com/
variables: {}
security:
- OAuth2: []
tags:
- name: Integrations
paths:
/v1/help-center-articles/{id}:
get:
callbacks: {}
deprecated: false
description: 'Get a help center article by its ID
## Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage company resources (`company_admin`) | View help articles (`help_center_article:read`) | - |
'
operationId: get_v1_help-center-articles_id
parameters:
- description: Help Center Article Zendesk ID
example: 12345679
in: path
name: id
required: true
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/HelpCenterArticleResponse'
description: Success
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundResponse'
description: Not Found
security:
- OAuth2AuthorizationCode:
- https://gateway.remote.com/company.manage
- help_center_article:read
- company_admin
- all:write
- all:read
OAuth2ClientCredentials:
- https://gateway.remote.com/company.manage
- help_center_article:read
- company_admin
- all:write
- all:read
summary: Get Help Center Article
tags:
- Integrations
/v1/scim/v2/Users/{id}:
get:
callbacks: {}
deprecated: false
description: Retrieves a single user for the authenticated company by user ID
operationId: get_v1_scim_v2_Users_id
parameters:
- description: User ID (slug)
in: path
name: id
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Integrations.Scim.User'
description: Success
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/Integrations.Scim.ErrorResponse'
description: Unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/Integrations.Scim.ErrorResponse'
description: Forbidden
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/Integrations.Scim.ErrorResponse'
description: Not Found
summary: Get user by ID via SCIM v2.0
tags:
- Integrations
/v1/webhook-events:
get:
callbacks: {}
deprecated: false
description: 'List all webhook events
## Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage company resources (`company_admin`) | View webhooks (`webhook:read`) | Manage webhooks (`webhook:write`) |
'
operationId: get_v1_webhook-events
parameters:
- description: Filter by webhook event type
example: timesheet.created
in: query
name: event_type
required: false
schema:
type: string
- description: Filter by delivery status (true = 200, false = 4xx/5xx)
example: true
in: query
name: successfully_delivered
required: false
schema:
type: boolean
- description: Filter by company ID
example: 123e4567-e89b-12d3-a456-426614174000
in: query
name: company_id
required: false
schema:
type: string
- description: Filter by date before (ISO 8601 format)
example: '2025-01-01T00:00:00Z'
in: query
name: before
required: false
schema:
type: string
- description: Filter by date after (ISO 8601 format)
example: '2025-01-01T00:00:00Z'
in: query
name: after
required: false
schema:
type: string
- description: Sort order
example: asc
in: query
name: order
required: false
schema:
enum:
- asc
- desc
type: string
- description: Field to sort by
example: first_triggered_at
in: query
name: sort_by
required: false
schema:
enum:
- first_triggered_at
type: string
- description: Starts fetching records after the given page
example: 1
in: query
name: page
required: false
schema:
default: 1
minimum: 1
type: integer
- description: Number of items per page
example: 20
in: query
name: page_size
required: false
schema:
default: 20
maximum: 100
minimum: 1
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ListWebhookEventsResponse'
description: Success
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedResponse'
description: Unauthorized
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundResponse'
description: Not Found
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/UnprocessableEntityResponse'
description: Unprocessable Entity
security:
- OAuth2ClientCredentials:
- https://gateway.remote.com/company.manage
- webhook:read
- webhook:write
- company_admin
- all:write
- all:read
summary: List Webhook Events
tags:
- Integrations
/v1/webhook-events/replay:
post:
callbacks: {}
deprecated: false
description: 'Replay webhook events
## Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage company resources (`company_admin`) | - | Manage webhooks (`webhook:write`) |
'
operationId: post_v1_webhook-events_replay
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ReplayWebhookEventsParams'
description: WebhookEvent
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessResponse'
description: Success
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedResponse'
description: Unauthorized
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundResponse'
description: Not Found
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/UnprocessableEntityResponse'
description: Unprocessable Entity
security:
- OAuth2ClientCredentials:
- https://gateway.remote.com/company.manage
- webhook:write
- company_admin
- all:write
summary: Replay Webhook Events
tags:
- Integrations
/v1/webhook-callbacks/{id}:
delete:
callbacks: {}
deprecated: false
description: 'Delete a callback previously registered for webhooks
## Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage company resources (`company_admin`) | - | Manage webhooks (`webhook:write`) |
'
operationId: delete_v1_webhook-callbacks_id
parameters:
- description: '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.
'
example: Bearer <COMPANY-SCOPED ACCESS TOKEN>
in: header
name: Authorization
required: true
schema:
type: string
- description: Webhook Callback ID
in: path
name: id
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessResponse'
description: Success
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedResponse'
description: Unauthorized
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundResponse'
description: Not Found
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/UnprocessableEntityResponse'
description: Unprocessable Entity
security:
- CustomerAPIToken:
- https://gateway.remote.com/company.manage
- webhook:write
- company_admin
- all:write
OAuth2AuthorizationCode:
- https://gateway.remote.com/company.manage
- webhook:write
- company_admin
- all:write
summary: Delete a Webhook Callback
tags:
- Integrations
patch:
callbacks: {}
deprecated: false
description: 'Update a callback previously registered for webhooks
## Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage company resources (`company_admin`) | - | Manage webhooks (`webhook:write`) |
'
operationId: patch_v1_webhook-callbacks_id
parameters:
- description: Webhook Callback ID
in: path
name: id
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateWebhookCallbackParams'
description: WebhookCallback
required: false
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookCallbackResponse'
description: Success
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedResponse'
description: Unauthorized
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundResponse'
description: Not Found
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/UnprocessableEntityResponse'
description: Unprocessable Entity
security:
- CustomerAPIToken:
- https://gateway.remote.com/company.manage
- webhook:write
- company_admin
- all:write
OAuth2AuthorizationCode:
- https://gateway.remote.com/company.manage
- webhook:write
- company_admin
- all:write
summary: Update a Webhook Callback
tags:
- Integrations
/v1/webhook-callbacks:
post:
callbacks: {}
deprecated: false
description: 'Register a callback to be used for webhooks
## Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage company resources (`company_admin`) | - | Manage webhooks (`webhook:write`) |
'
operationId: post_v1_webhook-callbacks
parameters:
- description: 'This endpoint works with any of the access tokens provided. You can use an access
token obtained through the Client Credentials flow, the Authorization Code flow, or the Refresh Token flow.
'
example: Bearer <ANY ACCESS TOKEN>
in: header
name: Authorization
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateWebhookCallbackParams'
description: WebhookCallback
required: false
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/WebhookCallbackResponse'
description: Success
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedResponse'
description: Unauthorized
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundResponse'
description: Not Found
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/UnprocessableEntityResponse'
description: Unprocessable Entity
security:
- CustomerAPIToken:
- https://gateway.remote.com/company.manage
- webhook:write
- company_admin
- all:write
OAuth2AuthorizationCode:
- https://gateway.remote.com/company.manage
- webhook:write
- company_admin
- all:write
OAuth2ClientCredentials:
- https://gateway.remote.com/company.manage
- webhook:write
- company_admin
- all:write
summary: Create a Webhook Callback
tags:
- Integrations
/v1/scim/v2/Users:
get:
callbacks: {}
deprecated: false
description: Retrieves a list of users for the authenticated company following SCIM 2.0 standard
operationId: get_v1_scim_v2_Users
parameters:
- description: 1-based index of the first result
example: 1
in: query
name: startIndex
required: false
schema:
type: integer
- description: Maximum number of results per page
example: 50
in: query
name: count
required: false
schema:
type: integer
- description: Filter expression for attributes (supports eq, ne, co, sw, ew, pr, lt, le, gt, ge)
in: query
name: filter
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Integrations.Scim.UserListResponse'
description: Success
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/Integrations.Scim.ErrorResponse'
description: Bad Request
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/Integrations.Scim.ErrorResponse'
description: Unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/Integrations.Scim.ErrorResponse'
description: Forbidden
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/Integrations.Scim.ErrorResponse'
description: Not Found
summary: List users via SCIM v2.0
tags:
- Integrations
/v1/scim/v2/Groups:
get:
callbacks: {}
deprecated: false
description: Retrieves a list of groups (departments) for the authenticated company following SCIM 2.0 standard
operationId: get_v1_scim_v2_Groups
parameters:
- description: 1-based index of the first result
example: 1
in: query
name: startIndex
required: false
schema:
type: integer
- description: Maximum number of results per page
example: 50
in: query
name: count
required: false
schema:
type: integer
- description: Filter expression for attributes (supports eq, ne, co, sw, ew, pr, lt, le, gt, ge)
in: query
name: filter
required: false
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Integrations.Scim.GroupListResponse'
description: Success
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/Integrations.Scim.ErrorResponse'
description: Bad Request
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/Integrations.Scim.ErrorResponse'
description: Unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/Integrations.Scim.ErrorResponse'
description: Forbidden
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/Integrations.Scim.ErrorResponse'
description: Not Found
summary: List groups via SCIM v2.0
tags:
- Integrations
/v1/custom-fields:
get:
callbacks: {}
deprecated: false
description: 'Returns custom fields definitions
## Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage employments (`employments`) | - | Manage custom fields (`custom_field:write`) |
'
operationId: get_v1_custom-fields
parameters:
- description: Starts fetching records after the given page
example: 1
in: query
name: page
required: false
schema:
default: 1
minimum: 1
type: integer
- description: Number of items per page
example: 20
in: query
name: page_size
required: false
schema:
default: 20
maximum: 100
minimum: 1
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ListEmploymentCustomFieldsResponse'
description: Success
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedResponse'
description: Unauthorized
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundResponse'
description: Not Found
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/UnprocessableEntityResponse'
description: Unprocessable Entity
security:
- CustomerAPIToken:
- https://gateway.remote.com/company.manage
- custom_field:write
- employments
- all:write
OAuth2AuthorizationCode:
- https://gateway.remote.com/company.manage
- custom_field:write
- employments
- all:write
summary: Lists custom fields definitions
tags:
- Integrations
post:
callbacks: {}
deprecated: false
description: 'Creates a new custom field definition.
## Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage employments (`employments`) | View custom fields (`custom_field:read`) | Manage custom fields (`custom_field:write`) |
'
operationId: post_v1_custom-fields
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateCustomFieldDefinitionParams'
description: Custom Field Definition Create Parameters
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CreateEmploymentCustomFieldResponse'
description: Success
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedResponse'
description: Unauthorized
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundResponse'
description: Not Found
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/UnprocessableEntityResponse'
description: Unprocessable Entity
security:
- CustomerAPIToken:
- https://gateway.remote.com/company.manage
- custom_field:read
- custom_field:write
- employments
- all:write
- all:read
OAuth2AuthorizationCode:
- https://gateway.remote.com/company.manage
- custom_field:read
- custom_field:write
- employments
- all:write
- all:read
summary: Create Custom Field Definition
tags:
- Integrations
/v1/employments/{employment_id}/custom-fields:
get:
callbacks: {}
deprecated: false
description: 'Returns a list of custom field values for a given employment
## Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage employments (`employments`) | View custom field values (`custom_field_value:read`) | Manage custom field values (`custom_field_value:write`) |
'
operationId: get_v1_employments_employment_id_custom-fields
parameters:
- description: Employment ID
example: ec23ebda-4b7a-4dbd-9d79-bd1eec3f83c9
in: path
name: employment_id
required: true
schema:
type: string
- description: Starts fetching records after the given page
example: 1
in: query
name: page
required: false
schema:
default: 1
minimum: 1
type: integer
- description: Number of items per page
example: 20
in: query
name: page_size
required: false
schema:
default: 20
maximum: 100
minimum: 1
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ListEmploymentCustomFieldValuePaginatedResponse'
description: Success
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedResponse'
description: Unauthorized
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundResponse'
description: Not Found
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/UnprocessableEntityResponse'
description: Unprocessable Entity
security:
- CustomerAPIToken:
- https://gateway.remote.com/company.manage
- custom_field_value:read
- custom_field_value:write
- employments
- all:write
- all:read
OAuth2AuthorizationCode:
- https://gateway.remote.com/company.manage
- custom_field_value:read
- custom_field_value:write
- employments
- all:write
- all:read
summary: List custom field value for an employment
tags:
- Integrations
/v1/companies/{company_id}/webhook-callbacks:
get:
callbacks: {}
deprecated: false
description: 'List callbacks for a given company
## Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage company resources (`company_admin`) | View webhooks (`webhook:read`) | Manage webhooks (`webhook:write`) |
'
operationId: get_v1_companies_company_id_webhook-callbacks
parameters:
- description: Company ID
example: d2091b1e-b1a4-437a-91ea-2809ffbb6d59
in: path
name: company_id
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ListWebhookCallbacksResponse'
description: Success
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedResponse'
description: Unauthorized
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundResponse'
description: Not Found
security:
- CustomerAPIToken:
- https://gateway.remote.com/company.manage
- webhook:read
- webhook:write
- company_admin
- all:write
- all:read
OAuth2AuthorizationCode:
- https://gateway.remote.com/company.manage
- webhook:read
- webhook:write
- company_admin
- all:write
- all:read
summary: List Webhook Callbacks
tags:
- Integrations
/v1/custom-fields/{custom_field_id}/values/{employment_id}:
get:
callbacks: {}
deprecated: false
description: 'Returns a custom field value for a given employment
## Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage employments (`employments`) | View custom field values (`custom_field_value:read`) | Manage custom field values (`custom_field_value:write`) |
'
operationId: get_v1_custom-fields_custom_field_id_values_employment_id
parameters:
- description: Custom field ID
example: ec23ebda-4b7a-4dbd-9d79-bd1eec3f83c9
in: path
name: custom_field_id
required: true
schema:
type: string
- description: Employment ID
example: ec23ebda-4b7a-4dbd-9d79-bd1eec3f83c9
in: path
name: employment_id
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/EmploymentCustomFieldValueResponse'
description: Success
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedResponse'
description: Unauthorized
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundResponse'
description: Not Found
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/UnprocessableEntityResponse'
description: Unprocessable Entity
security:
- CustomerAPIToken:
- https://gateway.remote.com/company.manage
- custom_field_value:read
- custom_field_value:write
- employments
- all:write
- all:read
OAuth2AuthorizationCode:
- https://gateway.remote.com/company.manage
- custom_field_value:read
- custom_field_value:write
- employments
- all:write
- all:read
summary: Show a custom field value
tags:
- Integrations
patch:
callbacks: {}
deprecated: false
description: 'Updates a custom field value for a given employment.
## Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage employments (`employments`) | - | Manage custom field values (`custom_field_value:write`) |
'
operationId: patch_v1_custom-fields_custom_field_id_values_employment_id (2)
parameters:
- description: Custom field ID
example: ec23ebda-4b7a-4dbd-9d79-bd1eec3f83c9
in: path
name: custom_field_id
required: true
schema:
type: string
- description: Employment ID
example: ec23ebda-4b7a-4dbd-9d79-bd1eec3f83c9
in: path
name: employment_id
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateEmploymentCustomFieldValueParams'
description: Custom Field Value Update Parameters
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/EmploymentCustomFieldValueResponse'
description: Success
'401':
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedResponse'
description: Unauthorized
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenResponse'
description: Forbidden
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundResponse'
description: Not Found
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/UnprocessableEntityResponse'
description: Unprocessable Entity
security:
- CustomerAPIToken:
- https://gateway.remote.com/company.manage
- custom_field_value:write
- employments
- all:write
OAuth2AuthorizationCode:
- https://gateway.remote.com/company.manage
- custom_field_value:write
- employments
- all:write
summary: Update a Custom Field Value
tags:
- Integrations
put:
callbacks: {}
deprecated: false
description: 'Updates a custom field value for a given employment.
## Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage employments (`employments`) | - | Manage custom field values (`custom_field_value:write`) |
'
operationId: patch_v1_custom-fields_custom_field_id_values_employment_id
parameters:
- description: Custom field ID
example: ec23ebda-4b7a-4dbd-9d79-bd1eec3f83c9
in: path
name: custom_field_id
required: true
schema:
type: string
- description: Employment ID
example: ec23ebda-4b7a-4dbd-9d79-bd1eec3f83c9
in: path
name: employment_id
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateEmploymentCustomFieldValueParams'
description: Custom Field Value Update Parameters
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/EmploymentCustomFieldValueResponse'
description: Success
'401':
content:
application/json:
schema
# --- truncated at 32 KB (98 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/remote/refs/heads/main/openapi/remote-integrations-api-openapi.yml