Get Document

Retrieve metadata for a single employee document by its ID.

GET /employee-documents/{id}

cURL

curl --request GET \
  --url "https://v1-api.ticket-plus.app/employee-documents/101" \
  --header "Authorization: Basic <base64(clientId:clientSecret)>"

200

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

Returns metadata for one document — its name, file type, and whether it can be downloaded. This endpoint does not return the file binary. To download the actual PDF, use Download Document after confirming downloadable: true.

cURL

curl --request GET \
  --url "https://v1-api.ticket-plus.app/employee-documents/101" \
  --header "Authorization: Basic <base64(clientId:clientSecret)>"

200

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

Always check downloadable before calling the download endpoint. Attempting to download a document with downloadable: false will return an error.

Path Parameters

id · integer · required

The unique numeric ID of the document to retrieve.

Response

data · object · required

Show properties

id · integer · required

Unique document identifier.

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 document is metadata-only or the file is not available.

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.

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 document to retrieve.

Response

200 - application/json

The requested document's metadata.

data · object

Show child attributes