Workspaces
Workspaces are the tenants within an organization. Each one holds a single product's data source, the profiles synced from it, and the lifecycle — states, signals and scores — evaluated over those profiles. A user's access to a workspace is governed by their organization role and any workspace-specific overrides.
The workspace object
The workspace object is the shape returned by endpoints in this collection. Its attributes are listed below.
Attributes
Time the workspace was created.
Unique identifier for the workspace.
The workspace's display name.
Organization that owns this workspace.
URL-safe identifier used in dashboard paths. Unique within the organization.
IANA timezone the workspace's calendar days are measured in. Null means UTC.
Time the workspace was last updated.
Day the workspace's week starts on, 0 (Sunday) through 6 (Saturday). Null means Monday.
{ "createdAt": "2026-01-01T00:00:00.000Z", "id": "wsp_01HJZQK7XJ8R9YGEWABCDEFGHJK", "name": "Acme Coffee", "organizationId": "org_01HJZQK7XJ8R9YGEWABCDEFGHJK", "slug": "acme-coffee", "timezone": "America/New_York", "updatedAt": "2026-01-01T00:00:00.000Z", "weekStartsOn": 0}List all workspaces
Returns every workspace the authenticated user belongs to across all of their organizations. Bounded today — nextPageUrl and previousPageUrl are always null — but the standard limit / page parameters are accepted so the contract stays stable if the result set ever grows. See Pagination. Requires a personal access token — API keys are bound to one workspace and cannot list cross-workspace.
Path & query parameters
Maximum number of items to return per page. Defaults to 20, capped at 100.
Opaque pagination token. Pass the value returned in nextPageUrl / previousPageUrl rather than constructing one — the encoding is internal and may change.
curl -X GET "https://api.uptend.io/v1/workspaces"{
"data": [
{
"createdAt": "2019-08-24T14:15:22Z",
"id": "wsp_01HJZQK7XJ8R9YGEWABCDEFGHJK",
"name": "Acme Coffee",
"organizationId": "org_01HJZQK7XJ8R9YGEWABCDEFGHJK",
"slug": "acme-coffee",
"timezone": "America/New_York",
"updatedAt": "2019-08-24T14:15:22Z",
"weekStartsOn": 0
}
],
"nextPageUrl": "http://example.com",
"previousPageUrl": "http://example.com"
}Retrieve a workspace
Returns a workspace by id.
Path & query parameters
The id of the workspace to operate on.
curl -X GET "https://api.uptend.io/v1/workspaces/wsp_01hh9zzzzzzzzzzzzzzzzzzzzz"{
"workspace": {
"createdAt": "2019-08-24T14:15:22Z",
"id": "wsp_01HJZQK7XJ8R9YGEWABCDEFGHJK",
"name": "Acme Coffee",
"organizationId": "org_01HJZQK7XJ8R9YGEWABCDEFGHJK",
"slug": "acme-coffee",
"timezone": "America/New_York",
"updatedAt": "2019-08-24T14:15:22Z",
"weekStartsOn": 0
}
}Update a workspace
Updates a workspace's name, slug, or calendar settings.
Path & query parameters
The id of the workspace to operate on.
Body parameters
The workspace's display name.
URL-safe identifier used in dashboard paths. Must be unique within the organization.
IANA timezone the workspace's calendar days are measured in. Send null to reset to UTC.
Day the workspace's week starts on, 0 (Sunday) through 6 (Saturday). Send null to reset to Monday.
curl -X PATCH "https://api.uptend.io/v1/workspaces/wsp_01hh9zzzzzzzzzzzzzzzzzzzzz" \ -H "Content-Type: application/json" \ -d '{}'{
"workspace": {
"id": "string",
"name": "string",
"slug": "string",
"timezone": "string",
"weekStartsOn": 0
}
}