On this page
Golden API reference
Find verified Golden API paths for security, entities, records, duplicates, quality, data scopes, resources, tasks, files, events, samples, and metrics.
Use the generated reference for exact methods, paths, request bodies, permissions, responses, and schemas. It describes the supported API for the documented Golden version.
API capabilities
| Capability | Reference | Start here |
|---|---|---|
| Authentication | Authentication API | Authentication |
| Users | Users API | Manage users |
| Integration tokens | Tokens API | Access tokens |
| Product discovery | Configuration API | API quickstart |
| Entities | Entity API | Create an entity |
| Search, records and duplicate decisions | Golden API | Search records |
| Tables, quality and audit | Table API | Table data |
| Resources | Resource API | Resource lifecycle |
| Executions and schedules | Tasks API | Tasks and schedules |
| Files | File API | Load data |
| Delivery events | Event API | Recover deliveries |
| Metrics | Metric API | Metrics |
| Data access | Scope API | Roles and scopes |
| Samples | Sample API | Install Aurelia |
Use the contract
Download the OpenAPI JSON for tooling and use the schema catalog to inspect linked models. Match the contract to the service you target. An API response can include additional fields; do not infer undocumented write support from read fields.
Permissions and asynchronous work
Roles and data scopes both matter. A viewer’s entity list and record searches
are filtered by granted access. Duplicate merge, disconnect, and delete actions
require ADMIN or STEWARD; ignoring and restoring ignored groups require
ADMIN. See the operation description for each action.
Background work uses /api/jobs/runs and /api/jobs/definitions. The old
/api/tasks routes are not supported by the current contract. Follow the
returned execution identifier instead of resubmitting a slow operation.
API explorer
Where enabled, the service’s Swagger UI presents its live contract. Use a test environment and suitable permissions when trying write operations. See API tools for the documentation explorer and API conventions for errors and pagination.