API Reference

List a Folder's (record) files

get
https://api-sbx.sidedrawersbx.com/api/v1/record-files/sidedrawer/sidedrawer-id//records/record-id//record-files

Returns a list of files within a given Drawer (sidedrawer) and Folder (record), using the Drawer identifier (sidedrawerId) and Folder identifier (recordId). 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.

Path Params
string
required

Drawer (sidedrawer) identifier.

string
required

Unique Folder (record) identifier (if Item type is record).

Query Params
string

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

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.

string

External key.

string

External key value.

Response

Updated 8 months ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago