Get licenses associated with a workspace license pool

Updated on Jul 10, 2026
Published on Jul 1, 2026

Get

/v1/teams/{team_id}/workspaces/{workspace_uuid}/license-pool/licenses

Security

HTTP

Type bearer

API key authentication. Create API keys in the Supermetrics Hub and send them in the Authorization header: Authorization: Bearer <your-api-key>

Path parameters

team_id

integer (int64) Required

The ID of the team

Minimum1

Maximum9223372036854776000

Example936506

workspace_uuid

string (uuid) Required

UUID of the workspace associated with the license pool

Max length36

Pattern^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

Example71bc0582-31b5-11f1-a55c-4201ac182030

Responses

200

Licenses retrieved successfully

Expand All

object

Response envelope containing license pool licenses

meta

object

Response metadata

Example{}

request_id

string

Unique ID of the request

Max length36

Pattern^[A-Za-z0-9_-]+

ExampleRfNUgKPReZtgmzkqAFe4ArjuCQXQuaRr

data

Array of object (LicensePoolLicenseData)

List of licenses

Max items1000

Example[]

object

License associated with a workspace license pool

license_id

integer (int64)

Unique identifier of the license

Minimum1

Maximum9223372036854776000

Example1

team_id

integer (int64)

ID of the team the license belongs to

Minimum1

Maximum9223372036854776000

Example123

team_name

string

Name of the team the license belongs to

Max length255

Pattern^.+

ExampleMy Team

allocated_seats

integer (int64)

Maximum number of users that can be assigned to this license

Minimum0

Maximum9223372036854776000

Example10

assigned_seats

integer (int64)

Number of users currently assigned to this license

Minimum0

Maximum9223372036854776000

Example5

allocated_accounts

integer (int64)

Number of accounts per data source allocated to this license

Minimum0

Maximum9223372036854776000

Example3

destinations

Array of string

Destinations available under this license

Max items50

Example[ "google_sheets", "excel" ]

string

Max length255

Pattern^.+

400

Bad request — invalid or missing parameters

object

message

string

Bad request error

Max length255

Pattern^.+$

code

string

BAD_REQUEST

Valid values[ "BAD_REQUEST" ]

401

Unauthorized — token is missing or invalid

object

message

string

Unauthorized access

Max length255

Pattern^.+$

code

string

UNAUTHORIZED

Valid values[ "UNAUTHORIZED" ]

403

Forbidden — insufficient permissions

object

message

string

Permission error

Max length255

Pattern^.+$

code

string

PERMISSION_ERROR

Valid values[ "PERMISSION_ERROR" ]

404

Workspace not found

object

message

string

Not found

Max length255

Pattern^.+$

code

string

NOT_FOUND

Valid values[ "NOT_FOUND" ]

422

Unprocessable entity — request failed validation

object

message

string

Validation failed for the request parameters

Max length255

Pattern^.+$

code

string

UNPROCESSABLE_ENTITY

Valid values[ "UNPROCESSABLE_ENTITY" ]

429

Too many requests - rate limit exceeded.

object

message

string

Too many requests

Max length255

Pattern^.+$

code

string

TOO_MANY_REQUESTS

Valid values[ "TOO_MANY_REQUESTS" ]

500

Internal server error

object

message

string

Internal server error

Max length255

Pattern^.+$

code

string

INTERNAL_SERVER_ERROR

Valid values[ "INTERNAL_SERVER_ERROR" ]

Was this article helpful?

Documentation Index

Get licenses associated with a workspace license pool