Skip to main content
The Bold API lets you read and update operational data from external systems. Use it to synchronize catalog, stock, orders, production, purchases, sales, and events with management systems, analytics tools, internal automations, or your own tools. To query data from ChatGPT Desktop or Claude Code, follow the MCP server guide.
The full reference is generated from OpenAPI. You can browse it in the API reference section or open https://api.bold-factory.com/docs.

​
What you can integrate

Master data

Products, items, properties, variants, and units.

Warehouse

Locations, lots, receipts, shipments, inventories, and stock.

Planning

Demand, supply, projected stock, customers, and suppliers.

Production

Recipes, versions, orders, operations, resources, and execution.

People and permissions

Users, permission profiles, employees, working hours, calendars, shifts, and tasks.

Maintenance

Assets, actions, causes, maintenance work orders, time, materials, and preventive schedules.

Purchases and sales

Purchase orders, sales orders, receipts, shipments, and lines.

Notifications

Events, personal subscriptions, the app inbox, and notification read status.

Analytics

Embedded Power BI reports, access credentials, report duplication, and report creation.

Labels

Templates, design elements, and PDF document generation.

​
Detailed reference

The API reference section uses https://api.bold-factory.com/openapi/v1.json to generate endpoints, parameters, request and response schemas, models, and interactive tests.

Open the external reference

Use Bold’s published reference to view it outside this documentation.

​
Basic pattern

Public endpoints include the version in their URL:
Responses and errors use JSON. Paginated lists return a common structure with results, pageNumber, pageSize, totalPages, and totalCount.

​
Consistency between modules

Some actions update more than one module. For example, a receipt increases physical stock and can also change data used in planning. These related changes can take a few seconds to appear in all views and queries. If your integration chains operations, read the resource again before making critical decisions. Use short retries when you depend on calculated data. For critical integrations, combine webhooks with paginated reconciliation. The webhook provides a prompt notification, and reconciliation confirms the final state.
1

Create an API key

Create a key in Control panel > Access > API keys. Use a different key for each integration so you can revoke it without affecting other systems.
2

Test reads before writes

Start with GET endpoints to validate authentication, tenant, permissions, and pagination.
3

Test reads before writes

Start with GET endpoints to validate authentication, organization, permissions, and pagination.
4

Synchronize identifiers

Save the Bold references returned by the endpoints. Avoid relying only on display names, because names can change.
5

Synchronize identifiers

Save the Bold references returned by the endpoints. Avoid relying only on display names, because names can change.
6

Enable webhooks

Use webhooks to receive change notifications without repeatedly polling the API.

​
Conventions

For critical integrations, combine webhooks with periodic paginated reconciliation. The webhook provides a prompt notification, and reconciliation detects any missed event.