Skip to main content
GET
/
workspaces
/
{workspaceId}
Get workspace
curl --request GET \
  --url http://localhost:4100/api/v1/workspaces/{workspaceId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "slug": "<string>",
  "ownerUserId": "<string>",
  "timezone": "<string>",
  "brandColor": "<string>",
  "logoUrl": "<string>",
  "deletedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Your Postbreeze API key

Path Parameters

​
workspaceId
string
required

Prefixed cuid of the workspace to fetch.

Example:

"ws_01HZX5T2K9Q3RB6N6JZP3RYV0M"

Response

The workspace.

​
id
string

Prefixed cuid identifier.

​
name
string

Display name.

​
slug
string

Globally unique URL slug.

​
ownerUserId
string

User id of the workspace owner.

​
timezone
string

IANA timezone the workspace is scheduled against.

​
timeFormat
enum<string>

Hour format used in the UI.

Available options:
H24,
H12
​
brandColor
string | null

Brand hex color used in the dashboard chrome. null when unset.

​
logoUrl
string | null

Workspace logo URL. null when unset.

​
deletedAt
string<date-time> | null

Set when the workspace has been soft-deleted; otherwise null.

​
createdAt
string<date-time>
​
updatedAt
string<date-time>