Objects
Custom object definitions, records, imports, and saved view endpoints served through Effect HttpApi.
Available Methods
Each method has its own page with request and response details, examples, and generated code snippets.
- GET/api/unstable/objects/{objectDefinitionId}/records/{id}
Get an object record by definition id and record id
- PATCH/api/unstable/objects/{objectId}/field
Update a single object field
- DELETE/api/unstable/objects/by-handle/{handle}
Delete all custom objects by handle
- POST/api/unstable/objects/by-handle/{handle}/by-ids
Resolve objects by ids
- POST/api/unstable/objects/by-handle/{handle}/import
Import object data
- POST/api/unstable/objects/by-handle/{handle}/import-mappings/suggest
Suggest object import mappings
- GET/api/unstable/objects/by-handle/{handle}/recent
Get recent objects by handle
- GET/api/unstable/objects/by-handle/{handle}/search
Search objects by handle
- GET/api/unstable/objects/by-handle/{objectHandle}/records/{id}
Get an object record by handle and id
- PUT/api/unstable/objects/by-handle/{objectHandle}/records/{id}
Update a custom object record by handle and id
- GET/api/unstable/objects/definitions
List custom object definitions
- POST/api/unstable/objects/definitions
Create a custom object definition
- GET/api/unstable/objects/definitions/{handle}
Get an object definition by handle
- GET/api/unstable/objects/definitions/{handle}/optional
Get an optional object definition by handle
- PUT/api/unstable/objects/definitions/{id}
Update an object definition
- GET/api/unstable/objects/definitions/native
List native object definitions
- POST/api/unstable/objects/query
Query object records
- POST/api/unstable/objects/records
Create a custom object record
- POST/api/unstable/objects/records/bulk
Create many custom object records
- GET/api/unstable/views
List views
- POST/api/unstable/views
Create a view
- DELETE/api/unstable/views/{id}
Delete a view
- GET/api/unstable/views/{id}
Get a view by id
- PUT/api/unstable/views/{id}
Update a view
- GET/api/unstable/views/default-object-config/{source}
Get default object view config
- PUT/api/unstable/views/default-object-config/{source}
Save default object view config