API Reference
Log In
API Reference

List a Folder's (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.

ℹ️

Versions

This endpoint also has a v2 version. Understand the difference here.

Path Params
string
required

Unique Drawer (sidedrawer) identifier.

string
required

Unique Folder (record) identifier.

Query Params
string

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

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.

string

External key.

string

External key value.

Response

Language
Credentials