Record API and data synchronization

Use the record API to bring Caraer data into your product and write useful results back. Records can be retrieved individually or queried with filters, sorting, and pagination. Create, update, and relationship operations let your integration participate in the customer’s workflow.

Why integrate

A customer can work with the same business entities in Caraer and your service. Your integration can read the fields it needs, apply its own processing, and return results to the records the customer already recognizes.

What you could build

A document service could find records awaiting a document, generate it in your backend, and write its reference and processing status back. A synchronization service could retain the external system’s identifier in a selected property and use it to find the existing record on later runs.

Start integrating

Follow API authentication, create and update records, and query records. Inspect POST /api/v2/records/index and the create-or-update operation in the API reference.

Choose which system owns each field, how you match identities, and how you handle deletions before enabling writes. Upsert matching depends on your configured identifiers; it is not a guarantee of automatic two-way conflict resolution. Check the saved record after writes and design retries around the operation’s documented behaviour.