Skip to main content
GET
/
employee-documents
/
{id}
curl --request GET \
  --url "https://v1-api.ticket-plus.app/employee-documents/101" \
  --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/101",
    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/101",
  {
    headers: { Authorization: `Basic ${credentials}` },
  },
);
console.log(await res.json());

{
  "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 --request GET \
  --url "https://v1-api.ticket-plus.app/employee-documents/101" \
  --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/101",
    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/101",
  {
    headers: { Authorization: `Basic ${credentials}` },
  },
);
console.log(await res.json());

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

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