---
title: "Get workspaces"
method: GET
path: "/workspaces"
tags: ["Workspace"]
---

# Get workspaces

`GET /workspaces`

Use this endpoint to retrieve the list of workspaces available for the specified user.

## Query parameters

- `offset` integer
- `limit` integer
- `sort` string
- `filter[name]` string
- `filter[id]` string
- `filter[workspace_admin]` 'true' | 'false'

## Headers

- `x-oneflow-api-token` string, required
- `x-oneflow-user-email` string, email

## Response `200`

Returns the list of [workspaces](workspace).

- object — A collection of workspaces.
  - `_links` object — Links to related endpoints.
    - `comments` object
      - `href` string, nullable
    - `contracts` object
      - `href` string, nullable
    - `contract` object
      - `href` string, nullable
    - `create` object
      - `href` string, nullable
    - `data_field` object
      - `href` string, nullable
    - `data_fields` object
      - `href` string, nullable
    - `events` object
      - `href` string, nullable
    - `event` object
      - `href` string, nullable
    - `files` object
      - `href` string, nullable
    - `file` object
      - `href` string, nullable
    - `next` object
      - `href` string, nullable
    - `parties` object
      - `href` string, nullable
    - `party` object
      - `href` string, nullable
    - `previous` object
      - `href` string, nullable
    - `publish` object
      - `href` string, nullable
    - `self` object
      - `href` string, nullable
    - `template_types` object
      - `href` string, nullable
    - `template_type` object
      - `href` string, nullable
    - `template` object
      - `href` string, nullable
    - `templates` object
      - `href` string, nullable
    - `workspaces` object
      - `href` string, nullable
    - `workspace` object
      - `href` string, nullable
    - `playbooks` object
      - `href` string, nullable
  - `count` integer, required
  - `data` object[], required
    - `_links` object — Links to related endpoints.
      - `comments` object
        - `href` string, nullable
      - `contracts` object
        - `href` string, nullable
      - `contract` object
        - `href` string, nullable
      - `create` object
        - `href` string, nullable
      - `data_field` object
        - `href` string, nullable
      - `data_fields` object
        - `href` string, nullable
      - `events` object
        - `href` string, nullable
      - `event` object
        - `href` string, nullable
      - `files` object
        - `href` string, nullable
      - `file` object
        - `href` string, nullable
      - `next` object
        - `href` string, nullable
      - `parties` object
        - `href` string, nullable
      - `party` object
        - `href` string, nullable
      - `previous` object
        - `href` string, nullable
      - `publish` object
        - `href` string, nullable
      - `self` object
        - `href` string, nullable
      - `template_types` object
        - `href` string, nullable
      - `template_type` object
        - `href` string, nullable
      - `template` object
        - `href` string, nullable
      - `templates` object
        - `href` string, nullable
      - `workspaces` object
        - `href` string, nullable
      - `workspace` object
        - `href` string, nullable
      - `playbooks` object
        - `href` string, nullable
    - `_permissions` object, required — This attribute contains the permission for the contract create operation in a workspace. If contract:create is true, this means that the user is allowed to create a contract in a particular workspace.
      - `contract:create` boolean, required
    - `_integration_permissions` object[] — A list of integration specific permissions. This exists only for specific integration tokens
      - `key` string, required
      - `value` string, required
    - `company_name` string — The name of the company.
    - `country_code` string, branding_country_code — The default country code used in all templates and contracts that belong to this workspace.
    - `created_time` string, datetime, nullable — The time when this workspace was created.
    - `date_format` string — The format of the date used in all templates and contracts that belong to this workspace.
    - `description` string — The description of this workspace.
    - `id` integer, required — The unique id of this workspace.
    - `name` string, required — The name of this workspace.
    - `registration_number` string — The registration number of the company.
    - `type` string — The type of the workspace.
    - `updated_time` string, datetime, nullable, required — The time when this workspace was last updated.

## Other responses

- `400` — Invalid format or content of the request.
- `401` — The API token or the user email is invalid.
- `403` — The request is not authorized by the server.

---

[API](https://skmtc.net/oneflow/apis/public-api-for-oneflow.md) · [All operations](https://skmtc.net/oneflow/apis/public-api-for-oneflow/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/oneflow/public-api-for-oneflow/versions/0e73a45dec15/schema)