Skip to main content
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 a workspace_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.
  • status is a label, not the numeric column — filter with the numeric status parameter (1 / 0) but read the string back.
  • Pagination values fall back to 0 when there are no matching records.

Headers

token
string
required

API token for authentication

Query Parameters

page
integer

Page number (default: 1)

limit
integer

Records per page (default: 10)

name
string

Partial workspace-name search (LIKE)

status
enum<integer>

Filter by workspace status: 1 active (default), 0 inactive

Available options:
0,
1

Response

Workspace list retrieved successfully

workspaces
object[]
pagination
object