Skip to main content
POST
/
workspaces
Create workspace
curl --request POST \
  --url http://localhost:4100/api/v1/workspaces \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Acme Co",
  "slug": "<string>",
  "timezone": "<string>"
}
'
{
  "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

Body

application/json
​
name
string
required

Display name for the workspace.

Required string length: 1 - 80
Example:

"Acme Co"

​
slug
string

Globally unique URL slug. Lowercase letters, digits, and dashes only. Generated from name when omitted.

​
timezone
string

IANA timezone. Defaults to UTC.

​
timeFormat
enum<string>

Hour format shown in the UI. Doesn't affect stored UTC instants.

Available options:
H24,
H12

Response

Workspace created.

​
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>