Files
> Auto-generated from the OpenAPI spec. Method names shown are the manifest > (canonical) names; per-language casing is applied by each SDK.
Record handle: ref(id) → a lazy handle to one File (get/update/delete, field values, related records). See record handles.
delete
DELETE /file/{fileId}
Delete an attached file
| Parameter | In | Required | Description |
|---|---|---|---|
fileId |
path | yes | ID of file |
Returns: any · Cost: 1 API call.
deleteRecord
DELETE /record/{recordId}/file/{fileId}
Delete record's file
| Parameter | In | Required | Description |
|---|---|---|---|
recordId |
path | yes | Record ID |
fileId |
path | yes | ID of file |
Returns: any · Cost: 1 API call.
deleteSpace
DELETE /space/{spaceId}/file/{fileId}
Delete an attached file
| Parameter | In | Required | Description |
|---|---|---|---|
spaceId |
path | yes | ID of space |
fileId |
path | yes | ID of file |
Returns: any · Cost: 1 API call.
download
GET /file/{fileId}/download
Download a file — Serves the file with an attachment Content-Disposition header and the original filename, triggering a browser download dialog.
| Parameter | In | Required | Description |
|---|---|---|---|
fileId |
path | yes | ID of file |
download |
query | no | Set to true to trigger a browser download dialog |
Returns: binary (bytes) · Cost: 1 API call.
fileSpace
GET /space/{spaceId}/file/
List attached files
| Parameter | In | Required | Description |
|---|---|---|---|
spaceId |
path | yes | ID of space |
filter |
query | no | Filter expression to narrow results. Format: field operator value. Multiple conditions are joined with ; or & (AND) or | (OR). Conditions can be grouped with parentheses. Supported operators: = (equals; also matches NULL when value is empty), != (not equals), >, >=, <, <=, ~ (LIKE, use % as wildcard; empty value matches NULL/empty), !~ (NOT LIKE), ... (IN set, comma-separated: statusId...1,2,3). OR across values for one field: status=(active|pending). Examples: filter=name=Acme, filter=created>=2024-01-01;assigneeId=, filter=name~%smith%;statusId...1,2,3, filter=(status=active|status=pending)&spaceId=5. |
offset |
query | no | Zero-based index of the first record to return. Use together with limit for pagination. Example: offset=20&limit=10 returns records 21–30. |
limit |
query | no | Maximum number of records to return. Use together with offset for pagination. |
order |
query | no | Sort order for results. Comma-separated list of field;DIRECTION pairs. Direction is ASC or DESC (default DESC when omitted). Example: order=name;ASC or order=id;ASC,name;DESC. |
Returns: list<File> · Cost: 1 API call per page (lazy paginator).
get
GET /file/{fileId}
Get a file record by ID
| Parameter | In | Required | Description |
|---|---|---|---|
fileId |
path | yes | ID of file |
Returns: File · Cost: 1 API call.
getRecord
GET /record/{recordId}/file/{fileId}
Get record's file
| Parameter | In | Required | Description |
|---|---|---|---|
recordId |
path | yes | Record ID |
fileId |
path | yes | ID of file |
Returns: File · Cost: 1 API call.
getSpace
GET /space/{spaceId}/file/{fileId}
Get an attached file
| Parameter | In | Required | Description |
|---|---|---|---|
spaceId |
path | yes | ID of space |
fileId |
path | yes | ID of file |
Returns: File · Cost: 1 API call.
checkRecordFileUpload
GET /record/{recordId}/file
Get record's file upload status
| Parameter | In | Required | Description |
|---|---|---|---|
recordId |
path | yes | Record ID |
resumableIdentifier |
query | yes | Reusmable identifier to check if part is uploaded |
Returns: any · Cost: 1 API call.
checkSpaceFileUpload
GET /space/{spaceId}/file
Get file upload status
| Parameter | In | Required | Description |
|---|---|---|---|
spaceId |
path | yes | ID of space |
resumableIdentifier |
query | yes | Reusmable identifier to check if part is uploaded |
Returns: any · Cost: 1 API call.
list
GET /file/
List file records
| Parameter | In | Required | Description |
|---|---|---|---|
filter |
query | no | Filter expression to narrow results. Format: field operator value. Multiple conditions are joined with ; or & (AND) or | (OR). Conditions can be grouped with parentheses. Supported operators: = (equals; also matches NULL when value is empty), != (not equals), >, >=, <, <=, ~ (LIKE, use % as wildcard; empty value matches NULL/empty), !~ (NOT LIKE), ... (IN set, comma-separated: statusId...1,2,3). OR across values for one field: status=(active|pending). Examples: filter=name=Acme, filter=created>=2024-01-01;assigneeId=, filter=name~%smith%;statusId...1,2,3, filter=(status=active|status=pending)&spaceId=5. |
offset |
query | no | Zero-based index of the first record to return. Use together with limit for pagination. Example: offset=20&limit=10 returns records 21–30. |
limit |
query | no | Maximum number of records to return. Use together with offset for pagination. |
order |
query | no | Sort order for results. Comma-separated list of field;DIRECTION pairs. Direction is ASC or DESC (default DESC when omitted). Example: order=name;ASC or order=id;ASC,name;DESC. |
Returns: list<File> · Cost: 1 API call per page (lazy paginator).
listRecord
GET /record/{recordId}/file/
List record's connected files
| Parameter | In | Required | Description |
|---|---|---|---|
recordId |
path | yes | Record ID |
filter |
query | no | Filter expression to narrow results. Format: field operator value. Multiple conditions are joined with ; or & (AND) or | (OR). Conditions can be grouped with parentheses. Supported operators: = (equals; also matches NULL when value is empty), != (not equals), >, >=, <, <=, ~ (LIKE, use % as wildcard; empty value matches NULL/empty), !~ (NOT LIKE), ... (IN set, comma-separated: statusId...1,2,3). OR across values for one field: status=(active|pending). Examples: filter=name=Acme, filter=created>=2024-01-01;assigneeId=, filter=name~%smith%;statusId...1,2,3, filter=(status=active|status=pending)&spaceId=5. |
offset |
query | no | Zero-based index of the first record to return. Use together with limit for pagination. Example: offset=20&limit=10 returns records 21–30. |
limit |
query | no | Maximum number of records to return. Use together with offset for pagination. |
order |
query | no | Sort order for results. Comma-separated list of field;DIRECTION pairs. Direction is ASC or DESC (default DESC when omitted). Example: order=name;ASC or order=id;ASC,name;DESC. |
Returns: list<File> · Cost: 1 API call per page (lazy paginator).
show
GET /file/{fileId}/show
Stream file inline for browser preview — Streams the file inline for browser preview. Add base64=true to receive the content as a base64-encoded JSON string instead of raw bytes.
| Parameter | In | Required | Description |
|---|---|---|---|
fileId |
path | yes | ID of file |
show |
query | no | Set to true to stream the file inline |
base64 |
query | no | Set to true to receive file content as a base64-encoded JSON string instead of raw bytes |
Returns: binary (bytes) · Cost: 1 API call.
update
PUT /file/{fileId}
Update a file record
| Parameter | In | Required | Description |
|---|---|---|---|
fileId |
path | yes | ID of file |
body |
body | yes |
Returns: File · Cost: 1 API call.
updateRecordFileWeight
PUT /record/{recordId}/file-weight
Update record file weight(s)
| Parameter | In | Required | Description |
|---|---|---|---|
recordId |
path | yes | ID of record |
body |
body | yes |
Returns: any · Cost: 1 API call.
updateSpace
PUT /space/{spaceId}/file/{fileId}
Update an attached file
| Parameter | In | Required | Description |
|---|---|---|---|
spaceId |
path | yes | ID of space |
fileId |
path | yes | ID of file |
body |
body | yes |
Returns: File · Cost: 1 API call.
upload
POST /file
Upload and register a file — Uploads a file from base64-encoded data. Accepts an optional sizes array for thumbnail generation. Validates MIME type and size limits.
| Parameter | In | Required | Description |
|---|---|---|---|
body |
body | yes |
Returns: File · Cost: 1 API call.
