---
title: "Fetching a list of Workspaces"
method: GET
path: "/workspaces"
tags: ["Workspaces"]
---

# Fetching a list of Workspaces

`GET /workspaces`

## Request

- Base URL: `https://api.mavenlink.com/api/v1`
- URL: `https://api.mavenlink.com/api/v1/workspaces`
- Auth: none declared

Gets a list of projects.

This endpoint has its own rate limit. See the [Knowledge Base](https://knowledge.kantata.com/hc/en-us/articles/9698066628123) for more information.

#### Archived Projects

By default, archived projects are not returned in the response. Use the `include_archived=true` filter
to retrieve archived projects.


This endpoint returns structured Workspace objects.
As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the `results` array
and will be indexed by ID in the `workspaces` top-level JSON key.
Please see our [Response Format](#section/Response-Format) section for more information.

## Query parameters

- `account_color_ids` string
- `archived` string
- `budgeted` boolean
- `by_custom_choice_value` string
- `by_custom_currency_value` string
- `by_custom_date_value` string
- `by_custom_number_value` string
- `by_custom_text_value` string
- `can_create_line_items` boolean
- `created_after` string, date-time
- `created_at` string
- `created_before` string, date-time
- `creator` string
- `current_user_is_maven_participant` boolean
- `custom_date_range` string
- `custom_integer_ranges` string
- `due_date_after` string, date
- `due_date_before` string, date
- `except` string
- `external_reference_external_message` string
- `external_reference_external_status` string
- `external_reference_service_model` string
- `external_reference_service_model_ref` integer
- `external_reference_service_model_refs` string
- `external_reference_service_name` string
- `external_reference_status` string
- `financials_viewable_by_user` boolean
- `for_approver` integer
- `has_approvers` boolean
- `has_external_references` boolean
- `has_maven_participant` integer
- `has_participant` integer
- `has_participation` boolean
- `has_value_for_custom_field_ids` string
- `include` string
- `include_archived` boolean
- `matching` string
- `milestone_weight_percentage_complete` string
- `on_account_by_orgs` boolean
- `on_my_account` boolean
- `only` string
- `only_joinable` boolean
- `only_participating_or_joinable` boolean
- `only_project_manager_in` boolean
- `optional_fields` string[]
- `order` string
- `page` integer
- `participant_or_org_member_in` boolean
- `pending_timesheet_submissions` string
- `per_page` integer
- `provider_lead` string
- `require_time_approvals` boolean
- `requiring_expense_approval` boolean
- `search` string
- `selected_choices` string
- `stage` string
- `start_date_after` string, date
- `start_date_before` string, date
- `updated_after` string, date-time
- `updated_before` string, date-time
- `user_not_participating` integer
- `viewable_for_time_administration` boolean
- `with_organizations` boolean
- `without_external_reference_service_name` string
- `workspace_groups` string

## Response `200`

A list of Workspaces have been retrieved.

- object
  - `count` integer
  - `meta` object
    - `count` integer
    - `page_count` integer
    - `page_number` integer
    - `page_size` integer
  - `results` object[]
    - `key` string
    - `id` string
  - `workspaces` object
  - `external_references` object
  - `stories` object
  - `users` object
  - `participations` object
  - `timesheet_submissions` object
  - `workspace_groups` object
  - `custom_field_values` object
  - `workspace_resources` object
  - `status_reports` object
  - `account_colors` object
  - `account_insights_mappings` object
  - `billing_milestones` object

## Other responses

- `400`: Bad Request
- `401`: Unauthorized request
- `403`: Forbidden request
- `404`: Page Not Found
- `422`: Unprocessable Entity
- `503`: Service is unavailable

---

[API](https://skmtc.dev/kantata/apis/kantata-ox-api-documentation.md) - [All operations](https://skmtc.dev/kantata/apis/kantata-ox-api-documentation/llms.txt) - [OpenAPI document](https://skmtc.dev/kantata/apis/kantata-ox-api-documentation/revisions/9d4ebed2fa98?raw)