List workspaces (API token)
Workspaces
List Workspaces (API Token)
Retrieve the workspaces available to the API token’s owner. Use the returned workspace_id values with workspace-scoped endpoints such as /campaign-list and /campaign-consumption.
GET
List workspaces (API token)
Retrieve the workspaces available to your API token. This is the lookup endpoint
for
workspace_id values used by workspace-scoped endpoints such as
List Campaigns and
Campaign Consumption.
The response is intentionally trimmed to the three fields an API consumer needs —
id, name and status. Owner, members, whitelisted domains and branding settings
are internal UI data and are not returned here.
API Endpoint
GET/api/v1/global/workspace-list
Base URL: https://www.tryunleashx.com
Authentication: Required (Token header: token or api_access_token)
Query Parameters
All parameters are optional.Success Response
Status Code:200 OK
Response Fields
Workspace Object
Pagination Object
Access Control
Only workspaces the API token’s owner is an active member of are returned. The token itself resolves to a user and a company; workspaces belonging to another company are never listed, so aworkspace_id obtained here is always safe to
pass to the campaign endpoints.
Example cURL
List all workspaces
Search workspaces by name
Page through a large list
Notes
- Results are sorted by creation date, newest first.
statusis a label, not the numeric column — filter with the numericstatusparameter (1/0) but read the string back.- Pagination values fall back to
0when there are no matching records.
Related Operations
- List Campaigns — accepts
workspace_id - Campaign Consumption — accepts
workspace_id
Headers
API token for authentication
Query Parameters
Page number (default: 1)
Records per page (default: 10)
Partial workspace-name search (LIKE)
Filter by workspace status: 1 active (default), 0 inactive
Available options:
0, 1 
