GET
/
{entity}
/
{id}
/
documents
Get documents for an entity
curl --request GET \
  --url http:localhost:3000/v2/{entity}/{id}/documents \
  --header 'x-API-Key: <api-key>'
[
  {
    "_id": "<string>",
    "number": 123,
    "companyId": "<string>",
    "status": {
      "status": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "createdBy": "<string>",
      "lastModifiedAt": "2023-11-07T05:31:56Z",
      "lastModifiedBy": "<string>"
    },
    "url": "<string>",
    "name": "<string>",
    "fileName": "<string>",
    "objectId": "<string>",
    "userId": "<string>",
    "jobId": "<string>",
    "customerId": "<string>",
    "absenceId": "<string>",
    "complaintId": "<string>",
    "uploadId": "<string>",
    "accessGroup": "<string>"
  }
]

Authorizations

​
x-API-Key
string
header
required

Path Parameters

​
entity
enum<string>
required

Entity type (e.g., object, user, job, customer)

Available options:
objects,
users,
jobs,
customers
​
id
string<objectid>
required

Entity ID

Query Parameters

​
includeObjectDocuments
boolean

Only relevant for jobs: If true, also include documents from job's objects

Response

200
application/json

List of documents

The response is of type Document · object[].