REremote-com
Resignations

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 by a company manager through the Authorization Code flow or the Refresh Token flow. See Authentication for partners.
  • Company-scoped access token (assertion) (OAuth2CompanyManagerAssertion) — obtained through the urn:ietf:params:oauth:grant-type:jwt-bearer grant for a company manager. See OAuth Assertion.
  • Customer API token (CustomerAPIToken) — generated by the customer on their Integration Settings page, with the scopes they choose there. See Authorization for customers.

Scopes

Any one of the scopes in a token type's row is enough. all:read and all:write work too.

Token typeCategoryRead only ScopeWrite only Scope (read access implicit)
Company-scoped access tokenManage employments (employments)View resignations (resignation:read)Manage resignations (resignation:write)
Company-scoped access token (assertion)Manage employments (employments)View resignations (resignation:read)Manage resignations (resignation:write)
Customer API tokenManage 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
    • OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: https://gateway.remote.com/company.manage
    • or OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: resignation:read
    • or OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: all:read
    • or OAuth 2
      Authorization code: /auth/oauth2/authorize
      Token URL: /auth/oauth2/token scopes: all:write
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: resignation:read
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: all:read
    • or OAuth 2
      Client credentials
      Token URL: /auth/oauth2/token scopes: all:write
    • or HTTP bearer

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 1 revision of this API.