Skip to main content
GET
/
employees
/
{id}
/
documents
curl --request GET \
  --url "https://v1-api.ticket-plus.app/employees/42/documents?page=1&perPage=10" \
  --header "Authorization: Basic <base64(clientId:clientSecret)>"
{
  "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": 1,
    "total": 1
  }
}

Documentation Index

Fetch the complete documentation index at: https://jobticket-docs.ticket-plus.app/llms.txt

Use this file to discover all available pages before exploring further.

Returns all documents associated with a given employee. For a company-wide view across all employees, use List All Documents instead.
curl --request GET \
  --url "https://v1-api.ticket-plus.app/employees/42/documents?page=1&perPage=10" \
  --header "Authorization: Basic <base64(clientId:clientSecret)>"
{
  "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": 1,
    "total": 1
  }
}
Check downloadable on each result before calling Download Document. Documents with downloadable: false cannot be fetched as binary files.

Path Parameters

id
integer
required
The unique numeric ID of the employee whose documents to list.

Query Parameters

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.

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.

Path Parameters

id
integer
required

The unique numeric ID of the employee whose documents to list.

Query Parameters

search
string | null

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

Response

200 - application/json

A paginated list of the employee's documents.

data
object
required