Developers

Workspaces

Retrieve workspace

get

https://api.typeform.com/workspaces/{workspace_id}

Retrieve a workspace.

Request

Path Parameters

workspace_id

string, required

Unique ID for the workspace.

Response

Status

200 OK

Schema

string

Unique identifier for the workspace.

name

string

Name of the workspace.

default

boolean

If the default workspace, true. Otherwise, false.

shared

boolean

If the workspace is shared with a team, true. Otherwise, false.

forms

object

href

string

Link to typeforms in the workspace.

count

integer

Number of typeforms in the workspace.

self

object

href

string

Link to the workspace.

account_id

string

ID in the ULID format of the account where workspace belongs to.

members

array of object

name

string

role

string

Valid values:ownermember

Example

{
  "id": "j23d34",
  "name": "A workspace of mine",
  "account_id": "01D8TTT2AZ3QWKC3DCNW74F1XW",
  "default": false,
  "shared": true,
  "forms": [
    {
      "href": "https://api.typeform.com/workspaces/j23d34/forms",
      "count": 12
    }
  ],
  "self": [
    {
      "href": "https://api.typeform.com/workspaces/j23d34"
    }
  ],
  "members": [
    {
      "name": "user",
      "email": "user@typeform.com",
      "role": "owner"
    },
    {
      "name": "user2",
      "email": "user2@typeform.com",
      "role": "member"
    },
    {
      "name": null,
      "email": "user3@typeform.com",
      "role": "member"
    }
  ]
}