Skip to main content

OpenAPI specification

The customer API is described by an OpenAPI 3.0 specification. It covers every endpoint, query parameter, response field, and error on these pages in a format that tools can read.

Download​

Download the OpenAPI specification (JSON).

What you can do with it​

  • Explore the API. Import the file into an API client such as Postman or Insomnia to get a ready-made request for each endpoint.
  • Generate a client. Use a generator such as OpenAPI Generator to produce typed client code for your language.
  • Validate responses. Use the schemas to check the data your integration receives.
  • Give it to an AI coding assistant. The file gives an assistant the exact endpoints and fields, so the code it writes matches the API.

Set your API key​

The specification declares one security scheme, a bearer token. In most tools this appears as an Authorization or Bearer token setting. Enter your API key there, without the word Bearer.

See Get started if you do not have a key yet.

Server URL​

The specification lists one server:

https://dev.nutritionistpro.com/v3/customer

What the specification covers​

The specification describes the format of a nutrient. The published nutrients themselves are listed on the Nutrients page.

Fields that can be empty​

Many fields are marked nullable in the specification. A field with no value is returned as null, so generated clients should treat those fields as optional values.

Four ingredient fields are left out of the response for an Axxya database ingredient: creator, account, created_at, and updated_at. The specification marks them as not required.