API Categories and Service IDs

Blueworks Live provides REST API that enables automation, integration, and reporting across your business processes. To securely access these APIs, you can use Service IDs or User Service IDs, depending on your use case.

Service IDs

Account administrators create Service IDs to allow automated systems (like scripts or integrations) to access Blueworks Live APIs. These IDs are authenticated by using OAuth 2.0 client credentials and are scoped to specific API categories.

For details on how to create service IDs see, Account-level service IDs

Table 1. Service ID characteristics
Attribute Description
Created by Account Administrators
Scope Account-wide, based on the assigned API category
Authentication OAuth 2.0 using the Client Credentials Grant
License usage No user license required
Primary use case Automated tasks such as reporting, user provisioning, or workflow management

For more details see, Service ID authentication

User service IDs

Individual users (if enabled by the admin) create User Service IDs individual users to access APIs with the same permissions as their user account. The user service IDs are ideal for personal automation or integrations that require user-level access.

For details on how to create user service IDs see, User service IDs

Table 2. User Service ID characteristics
Attribute Description
Created by Individual Users
Scope User-specific inherits the user’s permissions
Authentication OAuth 2.0
License usage No user license required
Primary use case User-level automation, such as managing personal tasks or accessing followed processes
For more details see, User Service ID authentication