API Reference

List Offboardings (v2). Requires a token issued via the authorization_code grant (company_manager role) — not usable with a client_credentials (integration) token.

get
https://gateway.remote.com/v2/offboardings

Lists offboardings for a company.

Authentication

This endpoint accepts any one of the following token types:

  • Company-scoped access token (OAuth2AuthorizationCode) — obtained through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page. See Authorization for customers.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage employments (employments)View offboarding requests (offboarding:read)Manage offboarding (offboarding:write)
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Filter by Employment ID

string
enum

Filter by offboarding type.

Allowed:
boolean

By default, the results do not include confidential termination requests.
Send include_confidential=true to include confidential requests in the response.

integer

Starts fetching records after the given page

integer

Change the amount of records returned per page, defaults to 20, limited to 100

Responses

Callback

Updated 4 months ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago

Did this page help you?