GET
/
documents
/
{id}
Get document by ID
curl --request GET \
  --url http:localhost:3000/v2/documents/{id} \
  --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

​
id
string<objectid>
required

Document ID

Response

200
application/json

Document retrieved successfully

A document represents a file or attachment stored in the system, with metadata and references to related entities. Base class for all entities in the system, providing common properties and methods.