Offboarding
Resignations
Download a resignation letter
Downloads a resignation letter from an employment request.
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 employment documents (employment_documents) | View resignation letters (resignation_letter:read) | - |
get/v1/resignations/{offboarding_request_id}/resignation-letter
Request
- Base URL: https://gateway.remote.com
- URL: https://gateway.remote.com/v1/resignations/{offboarding_request_id}/resignation-letter
- 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_letter:read, employment_documents, all:write, all:read)
Path parameters
offboarding_request_idstring required
Offboarding request ID
Response
Success
Changes
No recorded changes to this operation across all 65 revisions of this API.