Remote Offboarding API
The Offboarding API from Remote — 12 operation(s) for offboarding.
OpenAPI Specification
openapi: 3.0.0
info:
title: Remote Address Details Offboarding API
version: 0.1.0
servers:
- url: https://gateway.remote.com/
variables: {}
- url: https://gateway.remote-sandbox.com/
variables: {}
security:
- OAuth2: []
tags:
- name: Offboarding
paths:
/v1/offboardings:
get:
callbacks: {}
description: 'Lists Offboarding requests.
## Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage employments (`employments`) | View offboarding requests (`offboarding:read`) | Manage offboarding (`offboarding:write`) |
'
operationId: get_v1_offboardings
parameters:
- description: Filter by Employment ID
example: 93t3j-employment-id-9suej43
in: query
name: employment_id
required: false
schema:
type: string
- description: Filter by offboarding type
example: paid
in: query
name: type
required: false
schema:
type: string
- description: 'By default, the results do not include confidential termination requests.
Send `include_confidential=true` to include confidential requests in the response.
'
example: 'true'
in: query
name: include_confidential
required: false
schema:
type: string
- description: Starts fetching records after the given page
example: 1
in: query
name: page
required: false
schema:
type: integer
- description: Change the amount of records returned per page, defaults to 20, limited to 100
example: 30
in: query
name: page_size
required: false
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ListOffboardingResponse'
description: Success
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
description: Bad Request
'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
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsResponse'
description: Too many requests
security:
- CustomerAPIToken:
- https://gateway.remote.com/company.manage
- offboarding:read
- offboarding:write
- employments
- all:write
- all:read
OAuth2AuthorizationCode:
- https://gateway.remote.com/company.manage
- offboarding:read
- offboarding:write
- employments
- all:write
- all:read
summary: List Offboarding
tags:
- Offboarding
post:
callbacks: {}
description: 'Creates an Offboarding request
## Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage employments (`employments`) | - | Manage offboarding (`offboarding:write`) |
'
operationId: post_v1_offboardings
parameters: []
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateOffboardingParams'
description: Offboarding
required: false
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/OffboardingResponse'
description: Success
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
description: Bad Request
'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
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsResponse'
description: Too many requests
'500':
content:
application/json:
schema:
$ref: '#/components/schemas/RequestError'
description: Internal Server Error
security:
- CustomerAPIToken:
- https://gateway.remote.com/company.manage
- offboarding:write
- employments
- all:write
OAuth2AuthorizationCode:
- https://gateway.remote.com/company.manage
- offboarding:write
- employments
- all:write
summary: Create Offboarding
tags:
- Offboarding
/v2/offboardings:
get:
callbacks: {}
description: 'Lists offboardings for a company.
## Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage employments (`employments`) | View offboarding requests (`offboarding:read`) | Manage offboarding (`offboarding:write`) |
'
operationId: get_v2_offboardings
parameters:
- description: Filter by Employment ID
example: 93t3j-employment-id-9suej43
in: query
name: employment_id
required: false
schema:
type: string
- description: Filter by offboarding type.
example: termination
in: query
name: type
required: false
schema:
enum:
- termination
- resignation
- cancellation
- relocation
- transfer
- conversion
type: string
- description: 'By default, the results do not include confidential termination requests.
Send `include_confidential=true` to include confidential requests in the response.
'
example: true
in: query
name: include_confidential
required: false
schema:
type: boolean
- description: Starts fetching records after the given page
example: 1
in: query
name: page
required: false
schema:
type: integer
- description: Change the amount of records returned per page, defaults to 20, limited to 100
example: 30
in: query
name: page_size
required: false
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/V2ListOffboardingResponse'
description: Success
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
description: Bad Request
'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
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsResponse'
description: Too many requests
security:
- CustomerAPIToken:
- https://gateway.remote.com/company.manage
- offboarding:read
- offboarding:write
- employments
- all:write
- all:read
OAuth2AuthorizationCode:
- https://gateway.remote.com/company.manage
- offboarding:read
- offboarding:write
- employments
- all:write
- all:read
summary: List Offboardings (v2)
tags:
- Offboarding
/v2/offboardings/{id}:
get:
callbacks: {}
description: 'Returns a single offboarding by its ID.
## Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage employments (`employments`) | View offboarding requests (`offboarding:read`) | Manage offboarding (`offboarding:write`) |
'
operationId: get_v2_offboardings_id
parameters:
- description: Offboarding ID
in: path
name: id
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/V2OffboardingResponse'
description: Success
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
description: Bad Request
'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
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsResponse'
description: Too many requests
security:
- CustomerAPIToken:
- https://gateway.remote.com/company.manage
- offboarding:read
- offboarding:write
- employments
- all:write
- all:read
OAuth2AuthorizationCode:
- https://gateway.remote.com/company.manage
- offboarding:read
- offboarding:write
- employments
- all:write
- all:read
summary: Show Offboarding (v2)
tags:
- Offboarding
/v1/work-authorization-requests/{id}:
get:
callbacks: {}
deprecated: false
description: 'Show a single work authorization request.
## Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage employments (`employments`) | View work authorizations (`work_authorization:read`) | Manage work authorizations (`work_authorization:write`) |
'
operationId: get_v1_work-authorization-requests_id
parameters:
- description: work authorization request ID
example: 2d3cfb38-27e7-42de-a43d-da23e3d4ffea
in: path
name: id
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/WorkAuthorizationRequestResponse'
description: Success
'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
- work_authorization:read
- work_authorization:write
- employments
- all:write
- all:read
OAuth2AuthorizationCode:
- https://gateway.remote.com/company.manage
- work_authorization:read
- work_authorization:write
- employments
- all:write
- all:read
summary: Show work authorization request
tags:
- Offboarding
patch:
callbacks: {}
deprecated: false
description: 'Updates a work authorization request.
## Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage employments (`employments`) | - | Manage work authorizations (`work_authorization:write`) |
'
operationId: patch_v1_work-authorization-requests_id (2)
parameters:
- description: work authorization request ID
example: e2a7d189-1346-453a-9818-03772b716e48
in: path
name: id
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateWorkAuthorizationRequestParams'
description: Work Authorization Request
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/WorkAuthorizationRequestResponse'
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
- work_authorization:write
- employments
- all:write
OAuth2AuthorizationCode:
- https://gateway.remote.com/company.manage
- work_authorization:write
- employments
- all:write
summary: Update work authorization request
tags:
- Offboarding
put:
callbacks: {}
deprecated: false
description: 'Updates a work authorization request.
## Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage employments (`employments`) | - | Manage work authorizations (`work_authorization:write`) |
'
operationId: patch_v1_work-authorization-requests_id
parameters:
- description: work authorization request ID
example: e2a7d189-1346-453a-9818-03772b716e48
in: path
name: id
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateWorkAuthorizationRequestParams'
description: Work Authorization Request
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/WorkAuthorizationRequestResponse'
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
- work_authorization:write
- employments
- all:write
OAuth2AuthorizationCode:
- https://gateway.remote.com/company.manage
- work_authorization:write
- employments
- all:write
summary: Update work authorization request
tags:
- Offboarding
/v1/resignations/{offboarding_request_id}/resignation-letter:
get:
callbacks: {}
deprecated: false
description: 'Downloads a resignation letter from an employment request.
## Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage employment documents (`employment_documents`) | View resignation letters (`resignation_letter:read`) | - |
'
operationId: get_v1_resignations_offboarding_request_id_resignation-letter
parameters:
- description: Offboarding request ID
example: 3ab2e491-ad1c-47af-849c-3d0a53e20e0d
in: path
name: offboarding_request_id
required: true
schema:
type: string
responses:
'200':
content:
application/msword:
schema:
$ref: '#/components/schemas/GenericFile'
application/pdf:
schema:
$ref: '#/components/schemas/GenericFile'
application/vnd.openxmlformats-officedocument.wordprocessingml.document:
schema:
$ref: '#/components/schemas/GenericFile'
description: Success
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
description: Bad Request
'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
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsResponse'
description: Unprocessable Entity
security:
- CustomerAPIToken:
- https://gateway.remote.com/company.manage
- resignation_letter:read
- employment_documents
- all:write
- all:read
OAuth2AuthorizationCode:
- https://gateway.remote.com/company.manage
- resignation_letter:read
- employment_documents
- all:write
- all:read
summary: Download a resignation letter
tags:
- Offboarding
/v1/travel-letter-requests/{id}:
get:
callbacks: {}
deprecated: false
description: 'Show a single travel letter request.
## Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage employment documents (`employment_documents`) | View travel letters (`travel_letter:read`) | Manage travel letters (`travel_letter:write`) |
'
operationId: get_v1_travel-letter-requests_id
parameters:
- description: travel letter request ID
example: 93t3j-travel_letter_id-9suej43
in: path
name: id
required: true
schema:
$ref: '#/components/schemas/UuidSlug'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TravelLetterResponse'
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
- travel_letter:read
- travel_letter:write
- employment_documents
- all:write
- all:read
OAuth2AuthorizationCode:
- https://gateway.remote.com/company.manage
- travel_letter:read
- travel_letter:write
- employment_documents
- all:write
- all:read
summary: Show travel letter request
tags:
- Offboarding
patch:
callbacks: {}
deprecated: false
description: 'Updates a travel letter request
## Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage employment documents (`employment_documents`) | - | Manage travel letters (`travel_letter:write`) |
'
operationId: patch_v1_travel-letter-requests_id (2)
parameters:
- description: Travel letter Request ID
example: 3ab2e491-ad1c-47af-849c-3d0a53e20e0d
in: path
name: id
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateTravelLetterRequestParams'
description: Travel letter Request
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TravelLetterResponse'
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
- travel_letter:write
- employment_documents
- all:write
OAuth2AuthorizationCode:
- https://gateway.remote.com/company.manage
- travel_letter:write
- employment_documents
- all:write
summary: Updates a travel letter request
tags:
- Offboarding
put:
callbacks: {}
deprecated: false
description: 'Updates a travel letter request
## Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage employment documents (`employment_documents`) | - | Manage travel letters (`travel_letter:write`) |
'
operationId: patch_v1_travel-letter-requests_id
parameters:
- description: Travel letter Request ID
example: 3ab2e491-ad1c-47af-849c-3d0a53e20e0d
in: path
name: id
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateTravelLetterRequestParams'
description: Travel letter Request
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TravelLetterResponse'
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
- travel_letter:write
- employment_documents
- all:write
OAuth2AuthorizationCode:
- https://gateway.remote.com/company.manage
- travel_letter:write
- employment_documents
- all:write
summary: Updates a travel letter request
tags:
- Offboarding
/v1/travel-letter-requests:
get:
callbacks: {}
deprecated: false
description: 'List travel letter requests.
## Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage employment documents (`employment_documents`) | View travel letters (`travel_letter:read`) | Manage travel letters (`travel_letter:write`) |
'
operationId: get_v1_travel-letter-requests
parameters:
- description: Filter results on the given status
in: query
name: status
required: false
schema:
enum:
- pending
- cancelled
- declined_by_manager
- declined_by_remote
- approved_by_manager
- approved_by_remote
type: string
- description: Filter results on the given employment slug
in: query
name: employment_id
required: false
schema:
type: string
- description: Filter results on the given employee name
in: query
name: employee_name
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: submitted_at
in: query
name: sort_by
required: false
schema:
enum:
- submitted_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/ListTravelLettersResponse'
description: Success
'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
- travel_letter:read
- travel_letter:write
- employment_documents
- all:write
- all:read
OAuth2AuthorizationCode:
- https://gateway.remote.com/company.manage
- travel_letter:read
- travel_letter:write
- employment_documents
- all:write
- all:read
summary: List travel letter requests
tags:
- Offboarding
/v1/offboardings/employments/{employment_id}:
get:
callbacks: {}
description: 'Lists Offboarding requests for a specific employment.
## Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage employments (`employments`) | View offboarding requests (`offboarding:read`) | Manage offboarding (`offboarding:write`) |
'
operationId: get_v1_offboardings_employments_employment_id
parameters:
- description: Employment ID
in: path
name: employment_id
required: true
schema:
type: string
x-resource-type: employment
- description: Starts fetching records after the given page
example: 1
in: query
name: page
required: false
schema:
type: integer
- description: Change the amount of records returned per page, defaults to 20, limited to 100
example: 30
in: query
name: page_size
required: false
schema:
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ListOffboardingResponse'
description: Success
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestResponse'
description: Bad Request
'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
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/TooManyRequestsResponse'
description: Too many requests
security:
- CustomerAPIToken:
- https://gateway.remote.com/company.manage
- offboarding:read
- offboarding:write
- employments
- all:write
- all:read
OAuth2AuthorizationCode:
- https://gateway.remote.com/company.manage
- offboarding:read
- offboarding:write
- employments
- all:write
- all:read
summary: List Offboardings for Employment
tags:
- Offboarding
/v1/offboardings/{id}:
get:
callbacks: {}
description: 'Shows an Offboarding request.
## Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage employments (`employments`) | View offboarding requests (`offboarding:read`) | Manage offboarding (`offboarding:write`) |
'
operationId: get_v1_offboardings_id
parameters:
- description: Offboarding request ID
in: path
name: id
required: true
schema:
type: string
# --- truncated at 32 KB (139 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/remote/refs/heads/main/openapi/remote-offboarding-api-openapi.yml