Skip to content
  • There are no suggestions because the search field is empty.

Admin API

Quickstart on using the Nozzle Admin API

General Details

Across the various API calls, there are some template tokens to swap out and other useful vocab:

  • apiKey: contact Nozzle support to get an api key
  • workspaceId: Nozzle workspace id
  • teamId: Nozzle project id, which used to be called teams
  • versionId: a copy of your configuration is stored on each save, identified by the version id, which is the time it was saved, formatted as YYYYMMDDHHSS
  • id: the id of whatever object was just referenced

All ids in Nozzle are integers < 999999999999999 (15 digits), so that they are safe to be referenced in JavaScript and in Excel

Listing projects (called teams in the api)

curl 'https://api.nozzle.app/teams?workspaceId=' \
  -H 'accept: application/json' \
-H 'authorization: Token '
{
  "success": true,
  "data": [
    {
    "id": 123,
      "versionId": 250613161546,
    "workspaceId": 456,
      "name": "My Project",
      "slug": "myprojectslug",
      "description": "",
      "image": "",
      "kind": "team",
      "createdAt": "2025-06-13T16:15:46Z",
      "updatedAt": "2025-07-10T19:03:54Z",
      "deletedAt": "1970-01-01T00:00:00Z"
    }
  ]
}