Timesheets

Show timesheet

Shows a timesheet by its ID.

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 type	Category	Read only Scope	Write only Scope (read access implicit)
Company-scoped access token	Manage timeoffs (time_and_attendance)	View timesheets (timesheet:read)	Manage timesheets (timesheet:write)
Company-scoped access token (assertion)	Manage timeoffs (time_and_attendance)	View timesheets (timesheet:read)	Manage timesheets (timesheet:write)
Customer API token	Manage timeoffs (time_and_attendance)	View timesheets (timesheet:read)	Manage timesheets (timesheet:write)

get/v1/timesheets/{id}

Request

Base URL
https://gateway.remote.com
URL
https://gateway.remote.com/v1/timesheets/{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: timesheet: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: timesheet: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

Timesheet ID

Response

Success

Example response

{
  "data": {
    "timesheet": {
      "approval_required": true,
      "break_hours": {
        "hours": 35,
        "minutes": 13
      },
      "country_code": "PRT",
      "employment_id": "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
      "end_date": "2021-07-01",
      "holiday_hours": {
        "hours": 35,
        "minutes": 13
      },
      "id": "663e0b79-c893-45ff-a1b2-f6dcabc098b5",
      "night_hours": {
        "hours": 35,
        "minutes": 13
      },
      "notes": "Some notes",
      "on_call_hours": {
        "hours": 35,
        "minutes": 13
      },
      "overtime_hours": {
        "hours": 35,
        "minutes": 13
      },
      "regular_hours": {
        "hours": 35,
        "minutes": 13
      },
      "start_date": "2021-07-01",
      "status": "submitted",
      "submitted_at": "2021-07-15T18:18:17Z",
      "time_trackings": [
        {
          "clock_in": "2021-07-15T18:18:17Z",
          "clock_out": "2021-07-15T18:18:17Z",
          "has_holiday_hours": false,
          "has_night_hours": false,
          "has_weekend_hours": false,
          "holiday_hours": {
            "hours": 35,
            "minutes": 13
          },
          "night_hours": {
            "hours": 35,
            "minutes": 13
          },
          "notes": "Time tracking project.",
          "time_breakdown": {
            "day": {
              "holiday": {
                "hours": 35,
                "minutes": 13
              },
              "regular": {
                "hours": 35,
                "minutes": 13
              },
              "weekend": {
                "hours": 35,
                "minutes": 13
              }
            },
            "night": {
              "holiday": {
                "hours": 35,
                "minutes": 13
              },
              "regular": {
                "hours": 35,
                "minutes": 13
              },
              "weekend": {
                "hours": 35,
                "minutes": 13
              }
            }
          },
          "timezone": "Etc/UTC",
          "total_hours": {
            "hours": 35,
            "minutes": 13
          },
          "type": "regular_hours",
          "weekend_hours": {
            "hours": 35,
            "minutes": 13
          }
        }
      ],
      "total_hours": {
        "hours": 35,
        "minutes": 13
      },
      "unpaid_break_hours": {
        "hours": 35,
        "minutes": 13
      },
      "weekend_hours": {
        "hours": 35,
        "minutes": 13
      }
    }
  }
}

Changes

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