Grist Octri Preview
GET/docs/{docId}/attachments

List attachment metadata for a document

Lists attachment metadata records for a document. Use filter to match column values and sort or X-Sort to order results; use limit or X-Limit to cap the number of rows returned. The list may temporarily include attachments that are stored in the document but are not referenced by an Attachments type cell.

6 parameters
docIdstringrequired
The UUID of the document whose attachment metadata to list.
filterstringoptional
A JSON object mapping column names to arrays of allowed values; URL-encode the JSON string before sending it.
sortstringoptional
Column names to sort by, separated by commas. Prefix a column name with `-` for descending order; append supported options after a colon. Without this parameter, result order is unspecified.
limitnumberoptional
The maximum number of rows to return. A value of 0 means no limit.
X-Sortstringoptional
Header equivalent of the `sort` query parameter.
X-Limitnumberoptional
Header equivalent of the `limit` query parameter.

1 status code
200Returns an object containing a `records` array of attachment metadata records. The list may temporarily include attachments stored in the document but not referenced by an Attachments type cell.
recordsarray<object>required

Error handling

The docId path parameter must be a UUID. Encode the JSON object supplied to filter for use in a URL; limit may be set to 0 for no limit. Use column names in sort, prefix a name with - for descending order, and use only the documented options orderByChoice, naturalSort, and emptyLast.