On this page

API reference and client tools

Browse the API reference, download OpenAPI, and choose HTTP or generated clients for Golden integrations.

Start with the generated Golden API reference when you need to look up an operation or schema. It documents Golden 3.0.0 without requiring access to a running environment.

Where enabled, a Golden deployment provides an interactive explorer generated from the running product. Availability and path are deployment settings, so confirm them with the environment administrator.

Open Swagger UI

https://golden.example.com/swagger-ui

Select Authorize and enter the complete access-token value. Swagger UI sends it as a bearer credential.

The default explorer also answers at /swagger-ui.html, but either path can be changed or disabled, particularly in production.

Download the OpenAPI definition

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer ${GOLDEN_TOKEN}" \
  "${GOLDEN_URL}/api/configuration/openapi" \
  --output golden-openapi.json

Confirm the running product version:

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer ${GOLDEN_TOKEN}" \
  "${GOLDEN_URL}/api/configuration/version"

In Golden 3.0.0, GET /api/configuration/openapi serves the live OpenAPI document rather than a checked-in snapshot. Confirm that its info.version matches the product version when comparing it with a client contract.

Pin the verified definition with your integration and compare it when release communication identifies a relevant API change.

For client generation, use the curated customer contract published with this documentation:

curl --fail-with-body --silent --show-error \
  https://docs.trazadera.com/openapi/golden-openapi.json \
  --output golden-openapi.json

Customer-visible modules

ModuleCovers
ConfigurationProduct version and API definition
Authentication, users, access tokensHuman and integration identity operations
EntitiesEntity configuration, state, and synchronization
GoldenRecord search and duplicate-review operations
TablesTable configuration, records, and data operations
ResourcesDatasets and reusable data-flow or resolution configuration
TasksTask instances and schedules
Files, events, metricsSupporting user and administrator workflows

The running API definition can expose framework operations. Their presence does not make them supported customer integrations. Use the downloadable contract on this site for supported customer operations.

Generate a client

The curated public definition can be used with a conforming OpenAPI generator:

openapi-generator-cli generate \
  -i golden-openapi.json \
  -g python \
  -o generated/golden-client

Generated code remains tied to the definition used to create it. Regenerate and test it when release communication identifies a relevant contract change.

Command line access

Use an HTTP client such as curl for command line access to the REST API:

curl --fail-with-body --silent --show-error \
  --header "Authorization: Bearer ${GOLDEN_TOKEN}" \
  --header "Accept: application/json" \
  "${GOLDEN_URL}/api/entities"

For repeatable automation:

  1. Identify the target product version.
  2. Download the Golden OpenAPI contract that matches that version and pin it alongside the integration.
  3. Use a general OpenAPI generator or an approved organization-specific wrapper.
  4. Test the generated client against a non-production environment on every product upgrade.

See Make your first Golden API calls for connection setup and read-only examples. Use the generated API reference to inspect the available operations before automating them.

Java clients

Integrate Java applications with Golden through its REST API and a contract verified for the target deployment.

Golden does not currently distribute a public standalone Java client artifact. Use the public API contract to choose a client and check compatibility.

  1. Identify the target release with /api/configuration/version.
  2. Prefer your existing HTTP client or download the curated public OpenAPI contract matching the target release.
  3. Pin the verified definition with your application’s source before using an approved OpenAPI generator.
  4. Add the bearer credential at request time rather than embedding it in the generated source.
  5. Regenerate and run compatibility tests when release communication identifies a relevant public-contract change.
curl --fail-with-body --silent --show-error \
  https://docs.trazadera.com/openapi/golden-openapi.json \
  --output golden-openapi.json

openapi-generator-cli generate \
  -i golden-openapi.json \
  -g java \
  -o generated/golden-client

Golden 3.0.0 also serves its live OpenAPI document from /api/configuration/openapi. It can include private framework operations, so use it for comparison rather than expanding a client beyond the published customer contract.

If Trazadera supplies a separately versioned client artifact through an approved customer channel, use only its supplied coordinates and compatibility guidance.

Compatibility boundary

Treat the verified operation and schema set as the compatibility boundary. Keep integration code tolerant of additional response properties and avoid referencing endpoints outside the documented customer-visible modules.

Golden 3.0.0 · Published 2026-10-04