Getting started

The quickest way to try the Bizzkit Start API is the Scalar UI, where you can sign in with your own user and send requests directly from the browser.

This guide uses the Scalar UI of the non-production environment at https://startapi.bizzkit.biz/scalar/. In production, use https://startapi.bizzkit.cloud/scalar/ and the bizzkit.cloud domain instead. For more information, see Domain names.

Open the API explorer and authenticate

1. Open https://startapi.bizzkit.biz/scalar/.
2. In the Authentication panel, keep oauth2 selected. The API uses the authorization code flow, and the Client ID is prefilled with bizzkit-start-openapi.

3. Replace the placeholder Auth URL and Token URL, which start with https://auth-EXAMPLE.bizzkit.cloud, with the URLs of your own Bizzkit Auth:

   • Auth URL: https://example-auth.bizzkit.biz/connect/authorize
   • Token URL: https://example-auth.bizzkit.biz/connect/token

   Replace example with your customer name. 4. Keep the startapi/ scope selected. 5. Click Authorize and sign in with your Bizzkit user.

After authorizing, you can use Test Request directly from the endpoints in Scalar. The API resolves your tenant from the token, so all requests apply to your own environment.

Get the header navigation

1. Open GET /api/navigation.
2. Click Test Request.

The response contains the Start entry and the remaining header links. In the response, the links list the Bizzkit products enabled for your environment first, followed by your custom links. The shared header in the Bizzkit products shows the custom links first, followed by the product links.

Example response:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34

{
  "start": {
    "name": "Start",
    "url": "https://example-start.bizzkit.biz/",
    "target": "_self"
  },
  "links": [
    {
      "name": "Users",
      "url": "https://example-iam.bizzkit.biz/",
      "target": "_self"
    },
    {
      "name": "Media",
      "url": "https://example-dam.bizzkit.biz/",
      "target": "_self"
    },
    {
      "name": "Products",
      "url": "https://example-pim.bizzkit.biz/",
      "target": "_self"
    },
    {
      "name": "Wiki",
      "url": "https://wiki.example.com/",
      "target": "_blank"
    },
    {
      "name": "Support",
      "url": "https://support.example.com/",
      "target": "_self"
    }
  ]
}

Each link has the following fields:

• name: The text shown in the header. For Bizzkit products this is the product name, for example Users, AI, CMS, Search, Mail, Media, Products, or Content. For custom links it's the display name.
• url: The absolute URL the link points to.
• target: How the link opens. _self opens the link in the same window, and _blank opens it in a new tab.

The start entry is returned separately, so you can use it for the logo link in the header.

API reference

Use the full API reference when you need field-level details, response shapes, or less common endpoints.

Start API reference