Skip to content

Feature overview: API →

Integrating with refiroo

Use refiroo’s APIs to read reference data, supply changes or keep another system in step. Choose an interface by the contract your system needs, then give that system its own client identity.

Your task Start with
Work with records, relationships, models or change sets The management API in the API reference, objects and model tags
Read a stable business contract without knowing the underlying model Consumer APIs
Load many changes or exchange a file Bulk writes and files
Maintain a local copy Load, then follow changes
Receive notifications at your endpoint Consumer events and webhooks

The management API exposes the model and its runtime capabilities, including operations the browser does not use. Its names come from the model; applications and record types are configuration. Consumer APIs present selected business objects under names and versions declared by a model administrator. They are read-only.

Bulk writes, imports and exports produce jobs. A successful HTTP request can still contain refused items: inspect the job result. The raw change feed identifies changes without carrying values; consumer events identify affected business objects and can include their current representation.

Start by getting a token, discovering the model and learning paging and errors. For reviewed changes, use change sets and publication.

The documentation is at /docs. Operation details, request schemas and examples are in the API reference. These pages explain which operations to combine and how to recover when a sequence cannot finish.

Use Assistants and agents for an external MCP connection, or Assistant tasks to submit a workbook or instructions to the built-in assistant. Both prepare work for human review and cannot approve or publish. Provider features can propose mapping targets, turn questions into filters, or explain model changes and activity. Each needs its own permissions and configuration. Read About AI for what leaves the instance, charges and retained records before offering these actions in a client.