---
title: "Fetching a list of Workspace Resources"
method: GET
path: "/workspace_resources"
tags: ["Workspace Resources"]
---

# Fetching a list of Workspace Resources

`GET /workspace_resources`

## Request

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

This endpoint returns structured Workspace Resource 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 `workspace_resources` top-level JSON key.
Please see our [Response Format](#section/Response-Format) section for more information.

## Query parameters

- `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
- `created_after` string, date-time
- `created_before` string, date-time
- `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
- `has_external_references` boolean
- `has_value_for_custom_field_ids` string
- `include` string
- `include_unnamed` boolean
- `matching` string
- `only` string
- `only_unnamed` boolean
- `optional_fields` string[]
- `order` string
- `page` integer
- `per_page` integer
- `potential_workspace_resource_for_story_with_unnamed_resources` integer
- `potential_workspace_resources_for_reassignment` integer
- `potential_workspace_resources_for_story` integer
- `providers` boolean
- `providers_with_unnamed` boolean
- `role_id` integer
- `updated_after` string, date-time
- `updated_before` string, date-time
- `user_id` integer
- `with_organizations` boolean
- `without_external_reference_service_name` string
- `workspace_id` integer

## Response `200`

A list of Workspace Resources 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
  - `workspace_resources` object
  - `external_references` object
  - `users` object
  - `roles` object
  - `organization_memberships` object
  - `participations` object
  - `workspaces` object
  - `custom_field_values` 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)