Skip to main content

List Employee Files

GET /services/api/v1/employee_files​

Returns a list of employee files.

Optional Query Parameters​

ParameterTypeDescription
created_at_sincetimestampOnly return employee files that have been created since the specified timestamp.
updated_at_sincetimestampOnly return employee files that have been updated since the specified timestamp.
employee_file_category_idstringOnly return employee files that are in the provided category.
employee_idstringOnly return employee files that belong to the provided employee.

Response​

Results list.

{
  "entries": [
    {
      "id": "A96ey16n",
      "employee_id": "vke923ml",
      "employee_file_category_id": "KZBGNQz4",
      "date": "2024-07-27",
      "type_of": "custom",
      "display_name": "MY CV",
      "name": "MY CV",
      "file_url": "http://assets.onboard.org/uploads/employee_file/file/vM7WRbqLmEjpOQyag6P0/cv.pdf",
      "file_name": "cv.pdf",
      "file_size": 75637,
      "file_content_type": "application/pdf",
      "created_at": "2024-09-12T14:25:18.181Z",
      "updated_at": "2024-09-12T14:25:34.027Z"
    },
    {
      "id": "Lez8GJ6g",
      "employee_id": "k7Rf4gBMi"
      "employee_file_category_id": "da6K0nzA",
      "date": "2024-08-27",
      "type_of": "custom",
      "display_name": "STCED.pdf",
      "name": null,
      "file_url": "http://assets.onboard.org/uploads/employee_file/file/AJV7KrRz2QAg2wYZD8gG/STCED.pdf",
      "file_name": "STCED.pdf",
      "file_size": 1041137,
      "file_content_type": "application/pdf",
      "created_at": "2024-09-12T14:25:18.181Z",
      "updated_at": "2024-09-12T14:25:34.027Z"
    }
  ],
  "current_page": 1,
  "per_page": 30,
  "total_entries": 2
}