Developers

Workspaces

Retrieve workspaces

get
https://api.typeform.com/workspaces

Retrieve all workspaces you have access to.

Request

Query Parameters

search
string

Returns items that contain the specified string.

page
integer

The page of results to retrieve. Default 1 is the first page of results.

page_size
number

Number of results to retrieve per page. Default is 10. Maximum is 200.

Response

Status

200 OK

Schema

total_items
number

Total number of items in the retrieved collection.

page_count
number

Number of pages.

items Path 3
array of object
forms Path 3
object
count
integer

Number of typeforms in the workspace.

href
string

Link to typeforms in the workspace.

id
string

Unique identifier for the workspace.

name
string

Name of the workspace.

self Path 3
object
href
string

Link to the workspace.

shared
boolean

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

Example

{
  "items": [
    {
      "forms": [
        {
          "count": 12,
          "href": "https://api.typeform.com/workspaces/a1b2c3/forms"
        }
      ],
      "id": "a1b2c3",
      "name": "My Workspace",
      "self": [
        {
          "href": "https://api.typeform.com/workspaces/a1b2c3"
        }
      ],
      "shared": false
    }
  ],
  "page_count": 1,
  "total_items": 10
}