v1

latestOpenAPI 3.1.02026-07-242735131.1 MB

Files

List employment files

Lists files associated with a specific employment.

Supports filtering by file type and sub_type.

Scopes

Category	Read only Scope	Write only Scope (read access implicit)
Manage employment documents (employment_documents)	View documents (document:read)	Manage documents (document:write)

get/v1/employments/{employment_id}/files

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
}