Get workspaces

Authentication and permissions

Requests must include:

Authorization: Bearer <token>

Endpoint overview

Endpoint	Method	Summary	Response codes
/v1/workspaces	GET	User’s workspaces for the current team, with the forms relation	200, 401 (missing or invalid authentication), 403 (e.g. token missing the read ability)
/v1/workspaces/{workspace_id}	GET	One workspace with the forms relation	200, 401, 403 (no editor access to the workspace), 404 (not found)

URL and method

GET https://api.responsly.com/v1/workspaces

Headers

• Authorization: Bearer <token> — required, with the read ability.

cURL example

curl --request GET \
  --url 'https://api.responsly.com/v1/workspaces' \
  --header 'Authorization: Bearer <YOUR_ACCESS_TOKEN>'

Response format

The response is an object whose data key is an array of workspaces. Below is a simplified skeleton — additional workspace fields may be present. All identifiers are encoded strings.

{
  "data": [
    {
      "id": "<workspace_id>",
      "team_id": "<team_id>",
      "user_id": "<user_id>",
      "forms": [
        {
          "id": "<form_id>",
          "workspace_id": "<workspace_id>",
          "user_id": "<user_id>",
          "theme_id": "<theme_id>",
          "definition": {}
        }
      ]
    }
  ]
}

The definition field on each entry in forms is a JSON object describing the form (it can be large); the empty object above is only a type placeholder.

This list is not paginated.

Single workspace details

The {workspace_id} path parameter is the encoded workspace identifier (same format as the id field in the response). If the workspace does not exist the API returns 404; if you do not have editor access to it, the API returns 403.

URL and method

GET https://api.responsly.com/v1/workspaces/{workspace_id}

Headers

• Authorization: Bearer <token> — required, with the read ability.

cURL example

curl --request GET \
  --url 'https://api.responsly.com/v1/workspaces/<WORKSPACE_ID>' \
  --header 'Authorization: Bearer <YOUR_ACCESS_TOKEN>'

Response format

A single workspace with its forms, wrapped in an object with a data key.

{
  "data": {
    "id": "<workspace_id>",
    "team_id": "<team_id>",
    "user_id": "<user_id>",
    "forms": [
      {
        "id": "<form_id>",
        "workspace_id": "<workspace_id>",
        "user_id": "<user_id>",
        "theme_id": "<theme_id>",
        "definition": {}
      }
    ]
  }
}

As above: definition has a rich structure depending on the form — the empty object only illustrates the type.

Common errors

• 401 — missing Authorization header, invalid, or revoked token.
• 403 — token without the required read ability, or (for GET /v1/workspaces/{workspace_id}) the user does not have editor access to that workspace.
• 404 — for the detail endpoint only: no workspace found for the given {workspace_id}.