Employments
Files

List employment files

Changed on

Lists files associated with a specific employment.

Supports filtering by file type and sub_type.

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 documents (document:read)Manage documents (document:write)
get/v1/employments/{employment_id}/files

Request

  • Base URL: https://gateway.remote.com
  • URL: https://gateway.remote.com/v1/employments/{employment_id}/files
  • 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, document:read, document:write, employment_documents, all:write, all:read)

Path parameters

employment_idstring required

Employment ID

Query parameters

typestring

Filter by file type (optional)

sub_typestring

Filter by file sub_type (optional)

pageinteger

Starts fetching records after the given page

page_sizeinteger

Number of items per page

Response

Success

Example response

{
  "current_page": 1,
  "files": [
    {
      "id": "9880b711-file-id-ecf8f551bd78",
      "inserted_at": "2021-07-15T18:18:17Z",
      "name": "id.pdf",
      "sub_type": "personal_id",
      "type": "id"
    }
  ],
  "total_count": 1,
  "total_pages": 1
}

Changes

  • 6962720cf7e8Revision changes
    • warning

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

  • 1b32c4d801d1Revision changes
    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • warning

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