List of timesheets by contract

GET

/contracts/:contract_id/timesheets

GET

/rest/contracts/:contract_id/timesheets

curl -G https://api.letsdeel.com/rest/contracts/abcdefg/timesheets \
     -H "Authorization: Bearer <token>" \
     -d contract_types=ongoing_time_based \
     -d date_from=2022-12-31 \
     -d date_to=2022-12-31 \
     -d limit=10 \
     -d offset=0 \
     -d reporter_id=00000000-0000-0000-0000-000000000000 \
     -d statuses=approved

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "type": "work",
      "status": "approved",
      "contract": {
        "id": "abcdefg",
        "type": "ongoing_time_based",
        "title": "Senior Backend Engineer"
      },
      "quantity": 8,
      "worksheet": {
        "days": 0,
        "hours": 8,
        "weeks": 0,
        "minutes": 0
      },
      "created_at": "2022-05-04T03:45:27.108Z",
      "description": "Backend development work for sprint 42",
      "reported_by": {
        "id": "00000000-0000-0000-0000-000000000000",
        "full_name": "John Smith"
      },
      "total_amount": "200.0000",
      "currency_code": "GBP",
      "date_submitted": "2022-05-24T03:45:27.899Z",
      "scale": "hourly",
      "attachment": {
        "key": "attachments/timesheet_receipt.pdf",
        "filename": "timesheet_receipt.pdf"
      },
      "reviewed_by": {
        "id": "00000000-0000-0000-0000-000000000000",
        "remarks": "Approved after verification",
        "reviewed_at": "2022-05-04T03:45:27.899Z",
        "full_name": "Jane Smith"
      },
      "custom_scale": "night_shift",
      "payment_cycle": {
        "end_date": "2022-05-31T23:59:59.999Z",
        "start_date": "2022-05-01T00:00:00.000Z"
      },
      "hourly_report_preset": {
        "id": "00000000-0000-0000-0000-000000000000",
        "rate": 50,
        "title": "Standard Rate",
        "description": "Default hourly rate for backend engineers"
      }
    }
  ],
  "page": {
    "total_rows": 100
  }
}

Returns timesheets associated with the specified contract, with optional filtering by contract type, status, reporter, and date range.

Token scopes: timesheets:read

Authentication

AuthorizationBearer

Authentication

The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.

curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \
  -H 'Authorization: Bearer YOUR-TOKEN-HERE'

Learn more about authentication

AuthorizationBearer

Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Path parameters

contract_idstringRequired

Deel contract id.

Query parameters

contract_typeslist of enumsOptional

Filter results to timesheets associated with the specified contract types.

statuseslist of enumsOptional

Filter results to timesheets with the specified statuses.

reporter_idstringOptionalformat: "uuid"

Filter results to timesheets submitted by this user ID.

date_fromstringOptionalformat: "date"

Filter results to timesheets submitted on or after this date (inclusive). Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.

date_tostringOptionalformat: "date"

Filter results to timesheets submitted before this date (exclusive). Short date in format ISO-8601 (YYYY-MM-DD). For example: 2022-12-31.

limitstringOptional

Maximum number of records to return per page. NOTE: query parameters are passed as strings.

offsetstringOptional

Number of records to skip before starting to return results. NOTE: query parameters are passed as strings.

Response

Successful operation.

datalist of objects

List of timesheet entries associated with the specified contract.

pageobject

Pagination metadata for the response.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error