Changelog

October 2026#

New documentation#

This site replaces the API documentation that was published on Postman. It covers every endpoint, with its fields, errors and code in eight languages, a console to try requests from the page, and the guides.

• The description of the whole API is now downloadable as OpenAPI 3.1 (JSON), for generating clients and importing into tools.
• A Postman collection is made from the same description, for anyone who used the old one. Set its apiKey variable to your key.

Corrections to what the old documentation said:

• Update a member is PUT /users/{uid}.
• The member list of a project or folder is sent as members.
• Pages of List a person's projects page by page start at 1, and hold at most 200 projects.

Since the Postman documentation#

These were added to the API since the Postman documentation was last updated:

• Products: list, get, create, update and archive your catalogue.
• Key access: each key carries the access chosen for it; see Authentication.
• Sandbox keys: build against data kept apart from your real projects; see Live and sandbox.
• Webhooks: see Webhooks.
• Website restrictions and key rotation with a 24-hour overlap; see Authentication.
• Create an access token answers with expiresOn and environment.
• Get a project's measurements lists every product on a shape in productIds.