Skip to main content
GET
/
documents
/
v2
/
rs
List documents
curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/documents/v2/rs \
  --header 'Authorization: Bearer <token>' \
  --header 'x-session-token: <x-session-token>'
{
  "data": [
    {
      "id": 1,
      "name": "Document Name",
      "origin": {
        "type": "PLAN",
        "id": 123
      },
      "updatedAt": "2024-12-09T14:23:00.000Z",
      "createdAt": "2024-01-15T08:45:00.000Z",
      "actions": {
        "canBeUpdated": true,
        "canBeDeleted": true
      },
      "createdBy": {
        "id": 1,
        "firstName": "John",
        "lastName": "Doe"
      },
      "sites": [
        {
          "id": 1,
          "name": "Main site",
          "isEstablishment": true,
          "establishmentId": 10
        }
      ],
      "label": {
        "id": 1,
        "name": "Urgent",
        "color": "#FF5733"
      },
      "presignedUrl": "https://bucket.s3.amazonaws.com/1",
      "technicalInstallations": [
        {
          "id": 1,
          "name": "establishment_informations.installation_ascenseurs",
          "presignedUrl": "https://example.com/presigned-url"
        }
      ],
      "establishmentCell": {
        "establishment": {
          "id": 1,
          "establishmentSiteId": 5,
          "name": "Main site",
          "count": 123
        },
        "cell": {
          "id": 1,
          "name": "Main site",
          "count": 123
        }
      }
    }
  ],
  "totalCount": 100,
  "pagination": {
    "page": 1,
    "pageSize": 50
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-session-token
string
required

Session token used for authenticating the request.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjM0NTY3ODkwIiwic2Vzc2lvbklkIjoiYWJjZGVmMTIzNDU2IiwiaWF0IjoxNjA1MDk3ODk5LCJleHAiOjE2MDUxODQyOTl9.4XRQ1iXDyvEj5LgPZHbmTmzOZs98M3YPOzgf3MhxjaI"

Query Parameters

​
extend
enum<string>[]

Extend options:

  • "actions-info": Give information about the origin of the document

  • "created-by": Get information about the person who created the document

  • "sites": Get every sites linked

  • "label": Get label information

  • "presigned-url": Get presigned url of the documents

  • "technical-installations": Get information about the technical installations linked to the document

  • "establishment-cell": Get information about the establishment cell

Available options:
actions-info,
created-by,
sites,
label,
presigned-url,
technical-installations,
establishment-cell
​
whereName
string

Filter by document name (contains)

Example:

"string"

​
whereCreatedAt
object

Filter by creation date

Example:
{
  "start": "2021-01-01T00:00:00.000Z",
  "end": "2021-12-31T23:59:59.999Z"
}
​
whereUpdatedAt
object

Filter by update date

Example:
{
  "start": "2021-01-01T00:00:00.000Z",
  "end": "2021-12-31T23:59:59.999Z"
}
​
whereOriginType
string[]

Filter by document origin type

Example:
["A", "B", "C"]
​
whereOriginId
integer

Filter by document origin ID (requires whereOriginType)

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1

​
whereTechnicalInstallationIds
integer[]

Filter by technical installation IDs

Required range: -9007199254740991 <= x <= 9007199254740991
Example:
[1, 2, 3]
​
whereSiteIds
integer[]

Filter by site IDs

Required range: -9007199254740991 <= x <= 9007199254740991
Example:
[1, 2, 3]
​
whereCreatedBy
integer

Filter by creator ID

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1

​
whereLabel
integer[]

Filter by label ID

Required range: -9007199254740991 <= x <= 9007199254740991
Example:
[1, 2, 3]
​
whereLabelName
string

Filter by label name (contains)

Example:

"string"

​
whereIsDeleted
boolean

Filter by deleted documents

Example:

true

​
orderBy
object[]
​
includeCount
boolean
default:false

Include total count in response.

Example:

true

​
page
integer
default:1

Page number.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1

​
pageSize
integer
default:50

Page size.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

50

​
findId
integer

Get the page where the item with this id is located.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

1

​
subPageSize
integer
default:10

Sub page size for grouping items.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

10

Response

200 - application/json

Documents retrieved successfully

​
data
object[]
required
​
totalCount
integer

Total count of items.

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

100

​
pagination
object

Pagination information.