Skip to main content
A service account is a non-human identity for system integrations. You create one in Launchpad, assign buildings, set permissions, and generate credentials. Your integration then uses those credentials to authenticate with the KODE API. Open Service Accounts from the left sidebar. The table lists each account. Select a row to open Details and Permissions.

Details

Use Details to review the account and manage credentials.
  • View name, client ID, credential type, and description
  • Generate a private key or client secret
  • Edit or disable existing credentials
Service account detail page showing general information with email, created by, created at, credential type, client ID, and description, plus a Credentials section with a Generate Private Key button

The Details section shows account information and credential controls

Permissions

Use Permissions to grant Read and Write access per resource group. Assign only what the integration needs.
  • Edit Read or Write for each permission group
  • Limit the account to the buildings you assigned when you created it
See the permissions reference for each group and operation.
Service account Permissions page showing permission groups including BuildingsPublic, Actions, AreasPublic, DatasourcesPublic, DevicesPublic, MetersPublic, PointsPublic, SpacesPublic, TenantsPublic, TimeseriesPublic, and WorkOrdersPublic with green Read and orange Write permission badges

The Permissions section lists permission groups with Read and Write indicators

Create a service account

Create the account from the Service Accounts page, then generate credentials and set permissions.
You can update Details and Permissions after you create the account.
1

Open Service Accounts

In Launchpad, open Service Accounts from the left sidebar.
2

Select +Add Service

Select +Add Service to open the create dialog.
3

Configure the account

Enter a name, credential type, description, and site assignment.
Add New Service Account dialog with fields for name, credential type selection between Private JWT and Client Secret, description, and site selection, displayed over the Service Accounts table

The Add New Service Account dialog collects name, credential type, description, and sites

4

Save

Select Save to create the service account.
5

Generate credentials

Open the new account and generate credentials for the type you chose.
Select Generate Private Key on the detail page. Launchpad creates a key pair and downloads the private key file.
The private key downloads only once. Store it in a secure location. If you lose it, generate a new key and update your integration.
6

Authenticate with the KODE API

After you generate credentials, exchange them for an access token and call the API.

Common KODE API endpoints

API paths use the /api/v1/ structure under https://api.kodelabs.com/kodeos. Token requests use https://api.kodelabs.com/oauth2/v1/token. The table summarizes common endpoints for service account integrations. The KODE API reference is the source of truth for every endpoint, parameter, and response.
Grant matching Launchpad permissions before you call an endpoint. A valid token still returns 403 when the account lacks access to the building or operation.

Next steps

Permissions reference

Review Read and Write operations for each permission group.

Authenticate with the KODE API

Exchange service account credentials for a Bearer access token.

KODE API quickstart

Request a token and list the buildings your account can access.

KODE API reference

Browse every endpoint, or fork the Postman collection.
Last modified on November 14, 2026