Workspaces API Reference

Get your workspaces

Endpoint:

GET /v1/workspaces?page=:page&per_page=:per_page

• The default page number is 1.
• The default per_page number is 50 and the maximum is 100 items per page.

Example response:

[
  {
    "id": "cmihbdhw90001e7xh9kb3oko7",
    "createdAt": "2025-11-27T10:52:02.649Z",
    "updatedAt": "2025-11-27T10:52:03.498Z",
    "name": "Instatus",
    "slug": "instatus",
    "avatar": "https://dashboard.instatus.com/avatars/13.jpg",
    "sites": ["cmihbdhyg0005e7xhjhim8l74"],
    "sso": false,
    "organizationDomains": null,
    "allowDomainEmails": false,
    "allowedDomainsDefaultPermission": "READ",
    "ssoActive": false,
    "directorySyncActive": false,
    "enableMultipleOrgs": false,
    "allowedDomains": null,
    "allowedEmailDomains": [],
    "referralId": null,
    "referralCoupon": null,
    "referralCode": null,
    "sendNewWorkspaceMembersStatusPageUpdates": true,
    "sendNewWorkspaceMembersAutomationIntegrationNotifications": true,
    "sendNewWorkspaceMembersInvalidCustomDomainNotifications": true,
    "sendNewWorkspaceMembersPhoneCallNotifications": true,
    "sendNewWorkspaceMembersWeeklyReportsNotifications": true,
    "longRunningIncidentNotificationSettings": [0.5, 1, 2, 3, 6, 12],
    "useSSOLogin": true,
    "useGoogleLogin": true,
    "useMagiclinkLogin": true,
    "usePasswordLogin": true,
    "useGithubLogin": true
  },
  {
    "id": "cmjiq4ert0006bd6k027exx68",
    "createdAt": "2025-12-23T15:12:21.449Z",
    "updatedAt": "2025-12-23T15:18:57.744Z",
    "name": "Workspace 2",
    "slug": "workspace-2",
    "avatar": "https://dashboard.instatus.com/avatars/26.jpg",
    "sites": [],
    "sso": false,
    "organizationDomains": null,
    "allowDomainEmails": false,
    "allowedDomainsDefaultPermission": "READ",
    "ssoActive": false,
    "directorySyncActive": false,
    "enableMultipleOrgs": false,
    "allowedDomains": null,
    "allowedEmailDomains": [],
    "referralId": null,
    "referralCoupon": null,
    "referralCode": null,
    "sendNewWorkspaceMembersStatusPageUpdates": true,
    "sendNewWorkspaceMembersAutomationIntegrationNotifications": true,
    "sendNewWorkspaceMembersInvalidCustomDomainNotifications": true,
    "sendNewWorkspaceMembersPhoneCallNotifications": true,
    "sendNewWorkspaceMembersWeeklyReportsNotifications": true,
    "longRunningIncidentNotificationSettings": [0.5, 1, 2, 3, 6, 12],
    "useSSOLogin": true,
    "useGoogleLogin": true,
    "useMagiclinkLogin": true,
    "usePasswordLogin": true,
    "useGithubLogin": true
  }
]

Create a workspace

Endpoint:

POST /v1/workspaces

Example request:

{
  "name": "Instatus",
  "slug": "in-status",
  "sendNewWorkspaceMembersStatusPageUpdates": true,
  "sendNewWorkspaceMembersAutomationIntegrationNotifications": true,
  "sendNewWorkspaceMembersInvalidCustomDomainNotifications": true,
  "sendNewWorkspaceMembersPhoneCallNotifications": true,
  "sendNewWorkspaceMembersWeeklyReportsNotifications": true,
  "longRunningIncidentNotificationSettings": [0.5, 1, 2, 3, 6, 12]
}

Example response:

{
  "id": "cmjirgpcx0000c20yxm94si6q",
  "createdAt": "2025-12-23T15:49:54.647Z",
  "updatedAt": "2025-12-23T15:49:54.647Z",
  "name": "Instatus",
  "slug": "in-status",
  "avatar": null,
  "sso": false,
  "organizationDomains": null,
  "allowDomainEmails": false,
  "allowedDomainsDefaultPermission": "READ",
  "ssoActive": false,
  "directorySyncActive": false,
  "enableMultipleOrgs": false,
  "allowedDomains": null,
  "allowedEmailDomains": [],
  "referralId": null,
  "referralCoupon": null,
  "referralCode": null,
  "sendNewWorkspaceMembersStatusPageUpdates": true,
  "sendNewWorkspaceMembersAutomationIntegrationNotifications": true,
  "sendNewWorkspaceMembersInvalidCustomDomainNotifications": true,
  "sendNewWorkspaceMembersPhoneCallNotifications": true,
  "sendNewWorkspaceMembersWeeklyReportsNotifications": true,
  "longRunningIncidentNotificationSettings": [0.5, 1, 2, 3, 6, 12],
  "useSSOLogin": true,
  "useGoogleLogin": true,
  "useMagiclinkLogin": true,
  "usePasswordLogin": true,
  "useGithubLogin": true
}

Delete a workspace

Endpoint:

DELETE /v1/workspaces/:workspace_id

Example response:

{
  "id": "cmjirgpcx0000c20yxm94si6q"
}