Records
> 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 Record (get/update/delete, field values, related records). See record handles.
bulkUpdate
PUT /record
Bulk update records
| Parameter | In | Required | Description |
|---|---|---|---|
body |
body | yes | Array of records to be updated |
Returns: list<Record> · Cost: 1 API call.
create
POST /record
Create a record
| Parameter | In | Required | Description |
|---|---|---|---|
body |
body | yes | Record to be created. Optionally you may provide 'rawPayload' (string JSON or object) to auto-map fields. Explicit fields override values from rawPayload. |
Returns: Record · Cost: 1 API call.
delete
DELETE /record/{recordId}
Delete a record
| Parameter | In | Required | Description |
|---|---|---|---|
recordId |
path | yes | Record ID |
Returns: any · Cost: 1 API call.
getModule
GET /module/{moduleId}/item/{recordId}
Get a record by ID
| Parameter | In | Required | Description |
|---|---|---|---|
moduleId |
path | yes | Module ID |
recordId |
path | yes | Record ID |
Returns: Record · Cost: 1 API call.
getRecordById
GET /record/{recordId}
Get a record by ID
| Parameter | In | Required | Description |
|---|---|---|---|
recordId |
path | yes | Record ID |
Returns: Record · Cost: 1 API call.
getRecordByRemoteId
GET /record/remote/{remoteId}/{remoteApplication}
Get a record by remote ID
| Parameter | In | Required | Description |
|---|---|---|---|
remoteId |
path | yes | Remote ID of record to be synchronized |
remoteApplication |
path | yes | Name of remote application |
Returns: Record · Cost: 1 API call.
listDeleted
GET /record/deleted
Get deleted record IDs
| Parameter | In | Required | Description |
|---|---|---|---|
updatedSince |
query | yes | Unix timestamp; only return record IDs deleted after this point |
Returns: list<any> · Cost: 1 API call per page (lazy paginator).
listModule
GET /module/{moduleId}/item
List records
| Parameter | In | Required | Description |
|---|---|---|---|
moduleId |
path | yes | Module 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<Record> · Cost: 1 API call per page (lazy paginator).
list
GET /record
List 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. |
updatedSince |
query | no | Unix timestamp; only return items updated after this point |
Returns: list<Record> · Cost: 1 API call per page (lazy paginator).
update
PUT /record/{recordId}
Update a record
| Parameter | In | Required | Description |
|---|---|---|---|
recordId |
path | yes | Record ID |
body |
body | yes | Record data to be updated |
Returns: Record · Cost: 1 API call.
upsertRecordByRemoteId
POST /record/remote/{remoteId}/{remoteApplication}
Upsert a record by remote ID
| Parameter | In | Required | Description |
|---|---|---|---|
remoteId |
path | yes | Remote ID of record to be synchronized |
remoteApplication |
path | yes | Name of remote application |
body |
body | yes | Record data. Optionally you may provide 'rawPayload' (string JSON or object) to auto-map fields. Explicit fields override values from rawPayload. |
Returns: Record · Cost: 1 API call.
