Start developer overview
The Bizzkit Start API returns the shared header navigation for your environment and lets you manage the custom links shown in that header.
API host and tenant
There is one shared Start API host per environment, and it's shared by all customers in that environment:
- Production:
https://startapi.bizzkit.cloud - Non-production:
https://startapi.bizzkit.biz
For more information about production and non-production domains, see Domain names.
You don't use a customer-specific host. Instead, the API resolves your tenant from the issuer of the access token, which is your own Bizzkit Auth, for example https://example-auth.bizzkit.biz, where example is replaced by your customer name.
Authentication
Every request must include a bearer token issued by your Bizzkit Auth with the startapi/ scope. You can get a token in one of the following ways:
- Interactive sign-in in Scalar: Sign in with your own user directly in the API explorer. See Getting started.
- Machine client: Create a machine client with
startapi/inallowedScopesand request a token with the client credentials flow. See Continue with downstream clients in the User Management documentation.
Endpoints
| Method | Endpoint | Description |
|---|---|---|
GET |
/api/navigation |
Gets the header navigation: the Start entry and the remaining links. |
GET |
/api/application-links |
Lists all custom links. |
GET |
/api/application-links/{id} |
Gets a single custom link. |
POST |
/api/application-links |
Creates a custom link. |
PUT |
/api/application-links/{id} |
Updates a custom link. |
DELETE |
/api/application-links/{id} |
Deletes a custom link. |
Deprecated endpoint
GET /api/navigation-links is deprecated and returns the header navigation as a single flat list. Use GET /api/navigation instead.