Skip to main content
All CollectionsIntegrations and API
NetBeez API - Swagger Endpoints
NetBeez API - Swagger Endpoints
Panickos Neophytou avatar
Written by Panickos Neophytou
Updated over 3 weeks ago

NetBeez uses the Swagger framework to document the NetBeez API endpoints.

Go to https://<YOUR NETBEEZ INSTANCE>/swagger/index.html to access the API endpoint data for your NetBeez instance.

In order to access the endpoint data on the Swagger page, you will need to provide it with an API key. You can generate an API key in NetBeez Settings. See Settings - API Keys for more information on how to generate and manage API keys.

Once you input your API key and version number (it should default to "v1"), you will be able to view the endpoints.

Expand the categories to see and interact with all endpoints.

Did this answer your question?