Management API Collection

Management API Base URL

All Management API requests use the domain: https://saas.licensespring.com Do not use https://api.licensespring.com for Management API requests. That domain is reserved for the License API.

Required Authentication Key

The Management API requires the following key:

• managementApiKey

The keys below are not valid for the Management API:

• apiKey

• sharedKey

These keys apply exclusively to the License API and cannot be used for Management API authentication.

These settings are accessible in the LicenseSpring development environment, which must be selected in Postman.

Select environment

Management API variables

The Management API collection uses several environment variables that are automatically populated by running the corresponding List requests inside each folder. These variables allow PATCH, DELETE, and GET-by-ID operations to work without manual input.

Automatically populated variables

When you run the first request in a folder (e.g., List Customers, List Products, List Licenses), the script extracts the ID of the first returned item and stores it in the environment:

Variable	Description
customer_id	Set by running GET Customers
product_id	Set by running GET Products
license_id	Set by running GET Licenses
labels_id	Set by running GET Labels
features_id	Set by running the corresponding List Features request
user_id	Set by running List Users
order_id	Set by running List Orders
accounts_id	Set by running List Accounts
activation_id	Set by running List Activations
installation_id	Set by running List Installations
…	All other variables are set by their respective List requests

If a List request returns an empty array, it means no resources exist yet. You can either:

• Create the resource in the LicenseSpring UI, or

• Use the POST request provided in the same folder.

How the Management API Collection Works

Each folder in the Management API collection follows a consistent workflow:

1

Run the List request

• Retrieves all resources of that type.

• Automatically stores the ID of the first item in the environment variable.

• Example: GET Products → sets {{product_id}}.

2

Run other requests (Show, Patch, Delete, etc.)

• These requests automatically read the ID from the environment variable.

• No need to manually replace values.

• Simplifies testing and minimizes errors.

Why the first resource in the list?

For convenience and automation. If you want to target a different resource, you can simply change the environment variable manually (see below).

Manual variable adjustment (optional)

If you prefer to use an ID other than the automatically selected one, you can manually set a value in the environment:

1

Copy the ID from the UI

Example: from https://saas.licensespring.com/orders/order_id/license_

2

Paste it into the matching environment variable

Example: set license_id to the copied value.

3

Run any request in the folder

It will now use your manually selected ID.

Add your license_id

Or set it up from using POST/create request inside request body:

Add value to existing variable

• Important: the script will override your product_id if you run the List request again in that folder. Please delete/remove the post-response script as shown in the image if you want to preserve your manually set value.

OAuth Folders inside the Management API Collection

Some folders include OAuth-based Management API endpoints. These require:

• license_id, or

• customer_id, or

• customer_account_code

These variables are populated automatically by running the corresponding List requests. If you want OAuth requests to target different resources, update these variables manually.

If your organization has enabled OAuth scoping (customer-level, license-level, or account-level), the IDs must match the scope assigned on your LicenseSpring platform.

Example workflow

Products Folder Example:

1

Run GET Products → sets {{product_id}}

2

Run GET Product (Show) → uses {{product_id}}

3

Run PATCH Product → updates the same product

4

Run DELETE Product → deletes the same resource

Every folder works the same way.

Common Issues

404 Not Found

You ran PATCH/DELETE but no ID was set. Run the folder’s List request first.

401 Unauthorized

Your managementApiKey is missing or has a trailing space.

Invalid URL

Your management API URL has a trailing slash or extra space.

NOTE: Always ensure there are no extra spaces in any environment variable.