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
}
}
Employee Documents
List All Documents
Retrieve a paginated list of all employee documents across the entire company.
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
string
Full-text search across document names.
integer
default:"1"
Page number to return. Starts at
1.integer
default:"10"
Number of results per page. Maximum is
100.string
default:"desc"
Sort direction. Allowed values:
asc, desc.string
default:"id"
Field to sort results by. Allowed values:
id, employeeId, createdAt,
updatedAt.integer[]
Filter to a specific set of document IDs.
integer[]
Filter to documents belonging to specific employee IDs.
string[]
Filter by file extension, e.g.
pdf.Response
object
required
Show properties
Show properties
object[]
required
Array of document objects.
Show document object
Show document object
integer
required
Unique document identifier. Use this
id with the Download
Document endpoint.integer | null
ID of the employee this document belongs to.
string
required
Human-readable name of the document.
string
required
File extension of the document, e.g.
pdf.boolean
required
true if the file binary can be fetched via Download
Document. false means the file is
not available for download.string
required
ISO 8601 timestamp when the document was created.
string
required
ISO 8601 timestamp when the document was last updated.
string
required
Resource type label. Always
"employee-document".object
required
HAL hypermedia links.
integer
required
Current page number.
integer
required
Number of results per page.
integer
required
Total number of pages available.
integer
required
Total number of documents matching your filters.
Authorizations
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
Full-text search across document names.
Page number to return. Starts at 1.
Required range:
x >= 0Number of results per page. Maximum is 100.
Required range:
0 <= x <= 100Sort direction — asc for ascending, desc for descending.
Available options:
asc, desc Field to sort results by.
Available options:
id, employeeId, createdAt, updatedAt Filter to a specific set of document IDs.
Required range:
x >= 0Filter to documents belonging to specific employee IDs.
Required range:
x >= 0Filter by document file type (e.g. contract, payslip).
Response
200 - application/json
A paginated list of employee documents.
Show child attributes
Show child attributes