List All Documents

Retrieve a paginated list of all employee documents across the entire company.

GET /employee-documents

cURL

curl --request GET \
  --url "https://v1-api.ticket-plus.app/employee-documents?page=1&perPage=10" \
  --header "Authorization: Basic <base64(clientId:clientSecret)>"

200

{
  "data": {
    "data": [
      {
        "id": 101,
        "employeeId": 42,
        "documentName": "May 2024 Transit Invoice",
        "documentFileType": "pdf",
        "downloadable": true,
        "createdAt": "2024-05-01T09:00:00Z",
        "updatedAt": "2024-05-01T09:00:00Z",
        "resource": "employee-document",
        "_links": {
          "self": { "href": "https://v1-api.ticket-plus.app/employee-documents/101", "type": "application/json" },
          "employee": { "href": "https://v1-api.ticket-plus.app/employees/42", "type": "application/json" }
        }
      }
    ],
    "page": 1,
    "perPage": 10,
    "totalPages": 12,
    "total": 118
  }
}

Returns every document in the system across all employees, with support for filtering by employee ID, document file type, or specific document IDs. Use this for company-wide document reporting. To list documents for a single employee, use List Employee Documents instead.

cURL

curl --request GET \
  --url "https://v1-api.ticket-plus.app/employee-documents?page=1&perPage=10" \
  --header "Authorization: Basic <base64(clientId:clientSecret)>"

200

{
  "data": {
    "data": [
      {
        "id": 101,
        "employeeId": 42,
        "documentName": "May 2024 Transit Invoice",
        "documentFileType": "pdf",
        "downloadable": true,
        "createdAt": "2024-05-01T09:00:00Z",
        "updatedAt": "2024-05-01T09:00:00Z",
        "resource": "employee-document",
        "_links": {
          "self": { "href": "https://v1-api.ticket-plus.app/employee-documents/101", "type": "application/json" },
          "employee": { "href": "https://v1-api.ticket-plus.app/employees/42", "type": "application/json" }
        }
      }
    ],
    "page": 1,
    "perPage": 10,
    "totalPages": 12,
    "total": 118
  }
}

Query Parameters

search · string

Full-text search across document names.

page · integer · default: "1"

Page number to return. Starts at 1.

perPage · integer · default: "10"

Number of results per page. Maximum is 100.

sortOrder · string · default: "desc"

Sort direction. Allowed values: asc, desc.

sortField · string · default: "id"

Field to sort results by. Allowed values: id, employeeId, createdAt, updatedAt.

ids · integer[]

Filter to a specific set of document IDs.

employeeIds · integer[]

Filter to documents belonging to specific employee IDs.

documentFileTypes · string[]

Filter by file extension, e.g. pdf.

Response

data · object · required

Show properties

data · object[] · required

Array of document objects.

Show document object

id · integer · required

Unique document identifier. Use this id with the Download Document endpoint.

employeeId · integer | null

ID of the employee this document belongs to.

documentName · string · required

Human-readable name of the document.

documentFileType · string · required

File extension of the document, e.g. pdf.

downloadable · boolean · required

true if the file binary can be fetched via Download Document. false means the file is not available for download.

createdAt · string · required

ISO 8601 timestamp when the document was created.

updatedAt · string · required

ISO 8601 timestamp when the document was last updated.

resource · string · required

Resource type label. Always "employee-document".

_links · object · required

HAL hypermedia links.

Show properties

self · object · required

Link to this document resource.

Show properties

href · string · required

URL of this document.

type · string · required

Media type.

employee · object · required

Link to the employee who owns this document.

Show properties

href · string · required

URL of the owning employee.

type · string · required

Media type.

page · integer · required

Current page number.

perPage · integer · required

Number of results per page.

totalPages · integer · required

Total number of pages available.

total · integer · required

Total number of documents matching your filters.

Authorizations

Authorization · string · header · required

HTTP Basic Auth using your API key credentials. Use the username and password issued from the Developer Portal. Encode them as Base64(username:password) and pass in the Authorization: Basic <token> header.

Query Parameters

search · string | null

Full-text search across document names.

page · integer | null · default: 1

Page number to return. Starts at 1.

Required range: x >= 0

perPage · integer | null · default: 10

Number of results per page. Maximum is 100.

Required range: 0 <= x <= 100

sortOrder · enum<string> | null · default: desc

Sort direction — asc for ascending, desc for descending.

Available options: asc, desc

sortField · enum<string> | null · default: id

Field to sort results by.

Available options: id, employeeId, createdAt, updatedAt

ids · integer[] | null

Filter to a specific set of document IDs.

Required range: x >= 0

employeeIds · integer[] | null

Filter to documents belonging to specific employee IDs.

Required range: x >= 0

documentFileTypes · string[] | null

Filter by document file type (e.g. contract, payslip).

Response

200 - application/json

A paginated list of employee documents.

data · object · required

Show child attributes