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

import requests, base64

credentials = base64.b64encode(b"<clientId>:<clientSecret>").decode()

res = requests.get(
    "https://v1-api.ticket-plus.app/employee-documents",
    params={"page": 1, "perPage": 10},
    headers={"Authorization": f"Basic {credentials}"},
)
print(res.json())

const credentials = Buffer.from("<clientId>:<clientSecret>").toString("base64");

const res = await fetch(
  "https://v1-api.ticket-plus.app/employee-documents?page=1&perPage=10",
  { headers: { Authorization: `Basic ${credentials}` } },
);
console.log(await res.json());

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

import requests, base64

credentials = base64.b64encode(b"<clientId>:<clientSecret>").decode()

res = requests.get(
    "https://v1-api.ticket-plus.app/employee-documents",
    params={"page": 1, "perPage": 10},
    headers={"Authorization": f"Basic {credentials}"},
)
print(res.json())

const credentials = Buffer.from("<clientId>:<clientSecret>").toString("base64");

const res = await fetch(
  "https://v1-api.ticket-plus.app/employee-documents?page=1&perPage=10",
  { headers: { Authorization: `Basic ${credentials}` } },
);
console.log(await res.json());

{
  "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

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