Get Record files

get

https://tenants-gateway-api-sbx.sidedrawersbx.com/api/v1/tenants/tenant/tenant-id/{tenantId}/sidedrawer/sidedrawer-id/{sidedrawerId}/records/record-id/{recordId}/record-files

Path Params

tenantId

string

required

Tenant identifier.

sidedrawerId

string

required

Drawer (sidedrawer) source from which the files are taken.

recordId

string

required

Folder (record) source from which the files are taken.

Query Params

limit

string

Limit. Default value is 20.

startingAfter

string

Starting after is an object ID that defines your place in the list.

endingBefore

string

Object identifier that defines your place in the list.

displayInactive

string

return inactive 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.

fileTypeEnum

string

enum

Determines what kind of file is being pushed.

Allowed:

sort

string

enum

Defaults to DESC

Sort.

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

One of the file identification options. For example, fileNameWithExtension = myfile.docx.

uploadTitle

string

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

externalKey

string

External Key.

externalKeyValue

string

External Key Value.

Response

200

The record files has been successfully retrieved.

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here!