Time & Attendance
Time Off

Shows a single Time Off record

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 timeoffs (time_and_attendance)View timeoffs (timeoff:read)Manage timeoffs (timeoff:write)
get/v1/timeoff/{id}

Request

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

Path parameters

idstring required

Timeoff ID

Headers

Authorizationstring required

Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow.

The refresh token needs to have been obtained through the Authorization Code flow.

Response

Success

Example response

{
  "data": {
    "timeoff": {
      "automatic": false,
      "document": {
        "id": "9880b711-file-id-ecf8f551bd78",
        "inserted_at": "2021-07-15T18:18:17Z",
        "name": "id.pdf",
        "sub_type": "personal_id",
        "type": "id"
      },
      "employment_id": "5e55386e-4f4f-4def-92f4-bdc19a5ce77d",
      "end_date": "2021-12-21",
      "id": "0073fcb5-b669-4e4a-b963-2a47744e75a1",
      "leave_policy": {
        "leave_policy_variant_slug": "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
        "leave_type": "sick_leave",
        "name": "Self-Care"
      },
      "notes": "Some notes",
      "start_date": "2021-12-20",
      "status": "approved",
      "timeoff_days": [
        {
          "day": "2021-12-20",
          "hours": 8,
          "minutes": 480
        },
        {
          "day": "2021-12-21",
          "hours": 8,
          "minutes": 480
        }
      ],
      "timeoff_type": "paid_time_off",
      "timezone": "Asia/Kolkata",
      "total_minutes": 960
    }
  }
}

Changes

    • warning

      added the new adoption enum value to the /// response property for the response status

    • warning

      added the new adoption enum value to the // response property for the response status

    • warning

      added the new adv enum value to the /// response property for the response status

    • warning

      added the new adv enum value to the // response property for the response status

    • warning

      added the new blood_donation enum value to the /// response property for the response status

    • warning

      added the new blood_donation enum value to the // response property for the response status

    • warning

      added the new breastfeeding enum value to the /// response property for the response status

    • warning

      added the new breastfeeding enum value to the // response property for the response status

    • warning

      added the new business_trip_eu enum value to the /// response property for the response status

    • warning

      added the new business_trip_eu enum value to the // response property for the response status

    • warning

      added the new business_trip_non_eu enum value to the /// response property for the response status

    • warning

      added the new business_trip_non_eu enum value to the // response property for the response status

    • warning

      added the new career enum value to the /// response property for the response status

    • warning

      added the new career enum value to the // response property for the response status

    • warning

      added the new caregiver enum value to the /// response property for the response status

    • warning

      added the new caregiver enum value to the // response property for the response status

    • warning

      added the new celebration enum value to the /// response property for the response status

    • warning

      added the new celebration enum value to the // response property for the response status

    • warning

      added the new civic_duty enum value to the /// response property for the response status

    • warning

      added the new civic_duty enum value to the // response property for the response status

    • warning

      added the new exam enum value to the /// response property for the response status

    • warning

      added the new exam enum value to the // response property for the response status

    • warning

      added the new force_majeure enum value to the /// response property for the response status

    • warning

      added the new force_majeure enum value to the // response property for the response status

    • warning

      added the new health_day enum value to the /// response property for the response status

    • warning

      added the new health_day enum value to the // response property for the response status

    • warning

      added the new marriage enum value to the /// response property for the response status

    • warning

      added the new marriage enum value to the // response property for the response status

    • warning

      added the new marriage_child enum value to the /// response property for the response status

    • warning

      added the new marriage_child enum value to the // response property for the response status

    • warning

      added the new maternity_paid enum value to the /// response property for the response status

    • warning

      added the new maternity_paid enum value to the // response property for the response status

    • warning

      added the new maternity_unpaid enum value to the /// response property for the response status

    • warning

      added the new maternity_unpaid enum value to the // response property for the response status

    • warning

      added the new medical_visits enum value to the /// response property for the response status

    • warning

      added the new medical_visits enum value to the // response property for the response status

    • warning

      added the new monkhood enum value to the /// response property for the response status

    • warning

      added the new monkhood enum value to the // response property for the response status

    • warning

      added the new paternity_paid enum value to the /// response property for the response status

    • warning

      added the new paternity_paid enum value to the // response property for the response status

    • warning

      added the new paternity_unpaid enum value to the /// response property for the response status

    • warning

      added the new paternity_unpaid enum value to the // response property for the response status

    • warning

      added the new pregnancy_leave enum value to the /// response property for the response status

    • warning

      added the new pregnancy_leave enum value to the // response property for the response status

    • warning

      added the new public_duties enum value to the /// response property for the response status

    • warning

      added the new public_duties enum value to the // response property for the response status

    • warning

      added the new special enum value to the /// response property for the response status

    • warning

      added the new special enum value to the // response property for the response status

    • warning

      added the new sterilization enum value to the /// response property for the response status

    • warning

      added the new sterilization enum value to the // response property for the response status

    • warning

      added the new study enum value to the /// response property for the response status

    • warning

      added the new study enum value to the // response property for the response status

    • warning

      added the new sustainable_employability enum value to the /// response property for the response status

    • warning

      added the new sustainable_employability enum value to the // response property for the response status

    • warning

      added the new training enum value to the /// response property for the response status

    • warning

      added the new training enum value to the // response property for the response status

    • warning

      added the new transfer enum value to the /// response property for the response status

    • warning

      added the new transfer enum value to the // response property for the response status

    • warning

      added the new voluntary enum value to the /// response property for the response status

    • warning

      added the new voluntary enum value to the // response property for the response status

    • info

      added the required property //// to the response with the status

    • info

      added the required property // to the response with the status