Dev

REST & gRPC API

Product Guides Request a demo Open app

REST API#

Call Nominal’s services over HTTPS, with your API key. Request and response bodies are JSON unless an endpoint says otherwise.

You can also call many of the same services through the gRPC API. Several client libraries allow access Nominal without going to the low-level API.

Paths are relative to your base URL, such as https://api.gov.nominal.io/api, which is on the same page as your API key. Every request needs your API key as a bearer token: Authorization: Bearer <api key>.

Services#

Checklists and procedures#

Workbooks#

Access and administration#

Apps and integrations#

Errors#

A failed request gets an HTTP error status and a JSON body like this one:

{
  "errorCode": "NOT_FOUND",
  "errorName": "NominalAuthenticationGroupsV1:GroupErrorsNotFound",
  "errorInstanceId": "<error instance id>",
  "parameters": {}
}

errorName says which error it is, and each service’s page lists the errors it defines. errorCode is its kind, such as NOT_FOUND or INVALID_ARGUMENT. A 429 or 503 response has only parameters.