API
API

Admin API

Quickstart on using the Nozzle Admin API

Updated July 6, 20261 min read

General Details

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

  • apiKey: create your own from Settings → Users → Create API Token — see How do I create an API token?
  • workspaceId: Nozzle workspace id
  • teamId: Nozzle project id, which used to be called teams
  • versionId: an output-only integer returned in API responses, encoding the save time as YYMMDDHHMMSS. You don't need to send it in requests.
  • 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={{workspaceId}}' \
  -H 'accept: application/json' \
  -H 'authorization: Token {{apiKey}}'
{
  "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"
    }
  ]
}

Related articles