---
title: "Get Resource"
method: GET
path: "/v1/workspace/resources/{resource_id}"
tags: ["workspace"]
---

# Get Resource

`GET /v1/workspace/resources/{resource_id}`

Gets the metadata of a resource by ID.

## Path parameters

- `resource_id` string, required — The ID of the target resource.

## Query parameters

- `resource_type` 'voice' | 'voice_collection' | 'pronunciation_dictionary' | 'dubbing' | 'project' | 'convai_agents' | 'convai_knowledge_base_documents' | 'convai_tools' | 'convai_settings' | 'convai_secrets' | 'workspace_auth_connections' | 'convai_phone_numbers' | 'convai_mcp_servers' | 'convai_api_integration_connections' | 'convai_api_integration_trigger_connections' | 'convai_batch_calls' | 'convai_agent_response_tests' | 'convai_test_suite_invocations' | 'convai_crawl_jobs' | 'convai_crawl_tasks' | 'convai_kb_external_sync_jobs' | 'convai_whatsapp_accounts' | 'convai_agent_versions' | 'convai_agent_branches' | 'convai_agent_versions_deployments' | 'convai_memory_entries' | 'convai_coaching_proposals' | 'convai_templates' | 'dashboard' | 'dashboard_configuration' | 'convai_agent_drafts' | 'resource_locators' | 'assets' | 'content_generations' | 'content_templates' | 'songs' | 'transcription_tasks' | 'avatars' | 'avatar_video_generations' | 'resource_collection' | 'studio_projects' | 'convai_analysis_items', required — Resource types that can be shared in the workspace. The name always need to match the collection names

## Headers

- `xi-api-key` string, nullable — Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

## Response `200`

Successful Response

- ResourceMetadataResponseModel
  - `resource_id` string, required — The ID of the resource.
  - `resource_name` string, nullable, required — The name of the resource, if available.
  - `resource_type` 'voice' | 'voice_collection' | 'pronunciation_dictionary' | 'dubbing' | 'project' | 'convai_agents' | 'convai_knowledge_base_documents' | 'convai_tools' | 'convai_settings' | 'convai_secrets' | 'workspace_auth_connections' | 'convai_phone_numbers' | 'convai_mcp_servers' | 'convai_api_integration_connections' | 'convai_api_integration_trigger_connections' | 'convai_batch_calls' | 'convai_agent_response_tests' | 'convai_test_suite_invocations' | 'convai_crawl_jobs' | 'convai_crawl_tasks' | 'convai_kb_external_sync_jobs' | 'convai_whatsapp_accounts' | 'convai_agent_versions' | 'convai_agent_branches' | 'convai_agent_versions_deployments' | 'convai_memory_entries' | 'convai_coaching_proposals' | 'convai_templates' | 'dashboard' | 'dashboard_configuration' | 'convai_agent_drafts' | 'resource_locators' | 'assets' | 'content_generations' | 'content_templates' | 'songs' | 'transcription_tasks' | 'avatars' | 'avatar_video_generations' | 'resource_collection' | 'studio_projects' | 'convai_analysis_items', required — Resource types that can be shared in the workspace. The name always need to match the collection names
  - `creator_user_id` string, nullable, required — The ID of the user who created the resource.
  - `anonymous_access_level_override` 'admin' | 'editor' | 'commenter' | 'viewer', nullable, required — The access level for anonymous users. If None, the resource is not shared publicly.
  - `role_to_group_ids` object, required — A mapping of roles to group IDs. When the resource is shared with a user, the group id is the user's id.
  - `share_options` ShareOptionResponseModel[], required — List of options for sharing the resource further in the workspace. These are users who don't have access to the resource yet.
    - `name` string, required — The name of the principal.
    - `id` string, required — The ID of the principal.
    - `type` 'user' | 'group' | 'key', required — The type of the principal: user, group, or service account (under 'key').

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/elevenlabs/apis/elevenlabs-api-documentation.md) · [All operations](https://skmtc.net/elevenlabs/apis/elevenlabs-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/elevenlabs/elevenlabs-api-documentation/revisions/57d56f34628a/schema)