Show Resignation

Shows the details of a resignation with status submitted.

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

Category	Read only Scope	Write only Scope (read access implicit)
Manage employments (employments)	View resignations (resignation:read)	Manage resignations (resignation:write)

get/v1/resignations/{offboarding_request_id}

Request

Base URL: https://gateway.remote.com
URL: https://gateway.remote.com/v1/resignations/{offboarding_request_id}
Auth: HTTP bearer and OAuth 2 (authorization code, authorization URL /auth/oauth2/authorize, token URL /auth/oauth2/token, scopes: https://gateway.remote.com/company.manage, resignation:read, resignation:write, employments, all:write, all:read)

Path parameters

offboarding_request_idstring required

Offboarding request ID

Response

Success

Example response

{
  "data": {
    "resignation": {
      "contract_currency_code": "USD",
      "contract_job_title": "Developer",
      "contract_proabtion_period_passed": true,
      "contract_probation_period_end_date": "2021-06-15",
      "contract_start_date": "2021-03-15",
      "days_of_notice": 31,
      "paid_timeoffs_breakdown_labels": [
        "Used until today: 60 days",
        "Waiting for approval: 0 days"
      ],
      "proposed_last_day": "2024-04-12",
      "resignation_date": "2024-03-12",
      "resignation_reason_label": "Retirement"
    }
  }
}

Changes

No recorded changes to this operation across all 65 revisions of this API.