Spaces
> 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 Space (get/update/delete, field values, related records). See record handles.
create
POST /space
Create a space
| Parameter | In | Required | Description |
|---|---|---|---|
body |
body | yes |
Returns: Space · Cost: 1 API call.
delete
DELETE /space/{spaceId}
Delete a space
| Parameter | In | Required | Description |
|---|---|---|---|
spaceId |
path | yes | ID of Space |
Returns: any · Cost: 1 API call.
get
GET /space/{spaceId}
Get a space by ID
| Parameter | In | Required | Description |
|---|---|---|---|
spaceId |
path | yes | ID of Space |
Returns: Space · Cost: 1 API call.
list
GET /space
List spaces
| 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<Space> · Cost: 1 API call per page (lazy paginator).
update
PUT /space/{spaceId}
Update a space
| Parameter | In | Required | Description |
|---|---|---|---|
spaceId |
path | yes | ID of Space |
body |
body | yes |
Returns: Space · Cost: 1 API call.
weight
PUT /space/weight
Reorder spaces by weight — Reorders spaces by updating their display weight. Accepts either a single space object or an array. Admin-only; id and weight must be positive integers.
| Parameter | In | Required | Description |
|---|---|---|---|
body |
body | yes | Array of space IDs with their new weights |
Returns: list<Space> · Cost: 1 API call.
