List Direct Offboardings

Lists offboardings for global payroll employments, optionally filtered by employment ID.

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 employment model. Currently only 'global_payroll' is supported.

Allowed:
integer
≥ 1
Defaults to 1

Starts fetching records after the given page

integer
1 to 100
Defaults to 20

Number of items per page

Responses

Callback
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json