Sign in

v1

latestOpenAPI 3.1.02026-07-242735131.1 MB
Travel Letters

List travel letter requests

List travel letter requests.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage employment documents (employment_documents)View travel letters (travel_letter:read)Manage travel letters (travel_letter:write)
get/v1/travel-letter-requests

Query parameters

status'pending' | 'cancelled' | 'declined_by_manager' | 'declined_by_remote' | 'approved_by_manager' | 'approved_by_remote'

Filter results on the given status

employment_idstring

Filter results on the given employment slug

employee_namestring

Filter results on the given employee name

order'asc' | 'desc'

Sort order

sort_by'submitted_at'

Field to sort by

pageinteger

Starts fetching records after the given page

page_sizeinteger

Number of items per page

Response

Success

Example response

{
  "current_page": 1,
  "total_count": 1,
  "total_pages": 1,
  "travel_letter_requests": [
    {
      "additional_information": "Some additional information",
      "destination_country": {
        "alpha_2_code": "PT",
        "code": "PRT",
        "contractor_products_available": [
          "standard",
          "plus",
          "cor"
        ],
        "country_subdivisions": [
          {
            "code": "PT-06",
            "name": "Coimbra",
            "subdivision_type": "District"
          },
          {
            "code": "PT-11",
            "name": "Lisboa",
            "subdivision_type": "District"
          }
        ],
        "employment_agreement_preview_available": true,
        "eor_onboarding": true,
        "locked_benefits": "after_first_hire",
        "name": "Portugal",
        "region": "Europe",
        "subregion": "Southern Europe",
        "supported_json_schemas": [
          "additional_documents",
          "address_details",
          "administrative_details",
          "employment-basic-information",
          "bank_account_details",
          "contract_details",
          "emergency_contact"
        ]
      },
      "embassy_address": "some embassy address",
      "employer_approver": {
        "email": "user0@company.com",
        "id": "93aaf0b3-1d79-4d2c-8d47-3d5406727d70",
        "name": "User Name"
      },
      "employer_special_instructions": "Some special instruction",
      "id": "f4b4369e-cb29-47f0-a608-afd5e19a2102",
      "reason": "Some reason",
      "requires_travel_address": false,
      "responsible_for_accommodation_cost": "employee",
      "responsible_for_meal_cost": "employee",
      "responsible_for_travel_cost": "employee",
      "status": "pending",
      "submitted_at": "2021-07-15T18:18:17Z",
      "travel_address": "Some travel address",
      "travel_date_end": "2021-07-01",
      "travel_date_start": "2021-07-01",
      "travel_document_number": "FC123456",
      "travel_reason": "Some travel reason",
      "travel_reason_details": "Some details",
      "user": {
        "email": "user0@company.com",
        "id": "93aaf0b3-1d79-4d2c-8d47-3d5406727d70",
        "name": "User Name"
      }
    }
  ]
}