Contracts
Probation Extensions

Show Probation Extension

Shows a Probation Extension 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

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage employment documents (employment_documents)View probation documents (probation_document:read)Manage probation documents (probation_document:write)
get/v1/probation-extensions/{id}

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/probation-extensions/{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, probation_document:read, probation_document:write, employment_documents, all:write, all:read)

Path parameters

idstring required

Probation Extension Request ID

Response

Success

Example response

{
  "data": {
    "probation_extension": {
      "employment_id": "93t3j-employment_id-9suej43",
      "id": "93t3j-sfies9_id-9suej43",
      "requested_by": "93t3j-requested_by_id-9suej43",
      "status": "submitted",
      "submitted_at": "2021-09-01T00:00:00Z",
      "zendesk_ticket_url": "https://zendesk.com/tickets/123"
    }
  }
}

Changes