List all files within a Drawer (sidedrawer)

get

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

Provides a paginated list of all files (recordFile) within a Drawer (sidedrawer), without having to look in each Hanger (recordType) of the Drawer (sidedrawer).

Path Params

sidedrawerId

string

required

Drawer (sidedrawer) 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

boolean

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

correlationId

string

A correlationId is a unique parameter specifying the upload details of a file. This is used to "group" files uploaded as part of the same process.

fileType

string

enum

Enum that determines what kind of file is being pushed.

Allowed:

envelopeId

string

An envelopeId is used to identify signatures added to a document. This allows for the changes/signatures to be tracked and the completed (or most complete) document to be identified.

fileName

string

This is the unique name that the binary will have at 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

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successfully retrieved files.