Skip to main content
GET
/
documents
/
List documents by IDs
curl --request GET \
  --url http:localhost:3000/v2/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

Query Parameters

ids
string<objectid>[]

Filter by IDs (array of objectIds)

Response

List of documents

fileName
string
required

Original file name

accessGroup
string
required

Access group for the document (e.g. service, objectmanager)

_id
string<objectid>

Unique identifier of the entity

number
integer

Unique number of the entity, used for identification

companyId
string<objectid>

The ID of the company this entity belongs to

status
object

Entity Status information

url
string

URL to access the document file

name
string

Display name of the document

objectId
string<objectid>

Related object ID

userId
string<objectid>

Related user ID

jobId
string<objectid>

Related job ID

customerId
string<objectid>

Related customer ID

absenceId
string<objectid>

Related absence ID

complaintId
string<objectid>

Related complaint ID

uploadId
string<objectid>

Upload process ID