REremote-com
Probation Letters

Show probation completion letter

Show a single probation completion letter.

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 employment documents (employment_documents)View probation documents (probation_document:read)Manage probation documents (probation_document:write)
Company-scoped access token (assertion)Manage employment documents (employment_documents)View probation documents (probation_document:read)Manage probation documents (probation_document:write)
Customer API tokenManage employment documents (employment_documents)View probation documents (probation_document:read)Manage probation documents (probation_document:write)
get/v1/probation-completion-letter/{id}

Request

  • Base URL
    https://gateway.remote.com
  • URL
    https://gateway.remote.com/v1/probation-completion-letter/{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: probation_document: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: probation_document: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

idstring required

probation completion letter ID

Response

Success

Example response

{
  "data": {
    "probation_completion_letter": {
      "employment_id": "c7ee6462-a9cf-4a69-9806-5906b975f616",
      "id": "f4e2f1fe-2056-4d9f-b9e0-ea322b781eb7",
      "letter": {
        "id": "f4e2f1fe-2056-4d9f-b9e0-ea322b781eb7",
        "inserted_at": "2021-01-01T00:00:00Z",
        "name": "2024-05-29_Hero8_ProbationConfirmationLetter.pdf",
        "sub_type": "probation_completion_letter",
        "type": "contract"
      },
      "status": "submitted",
      "submitted_at": "2021-07-15T18:18:17Z",
      "zendesk_ticket_url": "https://zendesk.com/tickets/123"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.