List a Folder's (record) files (paginated)

get https://api-sbx.sidedrawersbx.com/api/v2/record-files/sidedrawer/sidedrawer-id/{sidedrawerId}/records/record-id/{recordId}/record-files

Returns a paginated list of files within a given Drawer (sidedrawer) and Folder (record). Folders (record) that have been "soft-deleted" can be returned using the optional query parameter displayInactive.

For files that require signatures, the parameter envelopeId keeps track of the added signatures and which document is the final version with all signatures.

ℹ️
Versions
This endpoint also has a v1 version. Understand the difference here.

Path Params

sidedrawerId

string

required

Unique Drawer (sidedrawer) identifier.

recordId

string

required

Unique Folder (record) identifier.

Query Params

limit

string

Limit of number of returned objects per page. Default is 20.

startingAfter

string

An object ID that defines a list object's position in the list by identifying the list object(s) appearing before it.

endingBefore

string

An object ID that defines a list object's position in the list by identifying the list object(s) appearing after it.

displayInactive

string

Set displayInactive = "true" to return inactive ("soft deleted") files.

correlationId

string

This is the details of the upload instance. It is not mandatory.

fileTypeEnum

string

Determines what kind of file is being pushed.

envelopeId

string

Used as an ID to connect/combine different files that will be part of a sequence of signatures. The objective is to have the envelopeId to track all signatures and which one is the latest one that combines them all.

fileName

string

This is the unique name that the binary will have in the SideDrawer Database. It has to be unique. This is mandatory, and it can be set by the App. In order to do so, add the timestamp when EACH file is posted (YYMMDDHHMMSS_*), all timestamps for each file will be different.

uploadTitle

string

This is what should be listed in the "File History" list.

externalKey

string

External key.

externalKeyValue

string

External key value.

Response

Language

Credentials

Bearer

JWT


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api-sbx.sidedrawersbx.com/api/v2/record-files/sidedrawer/sidedrawer-id/sidedrawerId/records/record-id/recordId/record-files \
3
     --header 'accept: application/json'


xxxxxxxxxx
52
}
1
{
2
  "data": [
3
    {
4
      "cloudStorage": false,
5
      "displayType": "review",
6
      "quarantined": false,
7
      "sealed": false,
8
      "active": true,
9
      "scan": false,
10
      "clean": false,
11
      "updatedAt": "2024-07-25T02:26:24.838Z",
12
      "recordDetail": "string",
13
      "fileType": "document",
14
      "fileName": "string",
15
      "fileSize": 1712138,
16
      "provider": "Amazon",
17
      "uploader": "string",
18
      "uploadTitle": "string",
19
      "fileUrl": "string",
20
      "id": "string",
21
      "uploaderOpenId": "string",
22
      "lastModifiedBy": "",
23
      "record": "string"
24
    },
25
    {

ℹ️Versions

200Successfully retrieved files.

ℹ️
Versions