Sign in
latestOpenAPI 3.0.02026-08-19219210532.7 KB

bd5a5f406bca

documents

Get a document by ID

get/api/v1/documents/{documentId}

Path parameters

documentIdstring uuid required

The unique identifier of the document

Response

contentSizeinteger required

The size of the document content in bytes

createdAtstring date-time required

The date and time the document was created

documentRole'attachment' | 'consent' required

Whether the document is an attachment or a consent document

fileNamestring required

The name of the document file

fileType'pdf' | 'pptx' | 'txt' required

The type of the document file

idstring uuid required

The unique identifier of the document

lastUpdatedAtstring date-time required

The date and time the document was last updated

organizationIdstring uuid required

The unique identifier of the organization that owns the document

uploadedBystring uuid required

The user ID who uploaded the document

versioninteger nullable

Monotonic version number; only set for consent documents