Skip to main content
The Bold API reference is published by the Bold service at https://api.bold-factory.com/docs. Use it to browse endpoints, parameters, schemas, examples, and interactive tests.

Open API documentation

Access the documentation published by Bold.

​
What it contains

  • Public version endpoints.
  • Path, query, and body parameters.
  • Request and response schemas.
  • Models and response codes.
  • Interactive tests against the API environment.

​
Before calling the API

You need a valid API key or session credential. For server-to-server integrations, create a key in Control panel > Access > API keys and send it in the X-Api-Key header.

Authentication

Prepare credentials and permissions before testing endpoints.

Pagination

Browse lists with pageNumber and pageSize.

​
OpenAPI specification

This section also includes pages generated from https://api.bold-factory.com/openapi/v1.json. Use Bold’s published documentation to test the API outside this documentation.