Skip to content
API Reference/
/
Get workspace

Get workspace

Request

Retrieve detailed information about a specific workspace including:

  • Workspace ID and name
  • Metrics (asset count, project count, template count, user count)
  • Complete branding configuration
  • Video prompts and ideas
  • Creator information
Security
ShuffllApiKey
Path
organizationIdstringrequired

Unique identifier for the organization

Example:693fb82afd8d1c43077ba0fb
workspaceIdstringrequired

Unique identifier for the workspace

Example:693fb82afd8d1c43077ba0fe
curl -i -X GET \
  https://api-docs.shuffll.com/_mock/apis/auth/organization/693fb82afd8d1c43077ba0fb/workspace/693fb82afd8d1c43077ba0fe \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successfully retrieved workspace details.

Bodyapplication/json
idstring

Workspace identifier

Example:"693fb82afd8d1c43077ba0fe"
namestring

Workspace name

Example:"My Workspace"
assetCountinteger

Number of assets in workspace

projectCountinteger

Number of projects in workspace

templateCountinteger

Number of templates in workspace

userCountinteger

Number of users in workspace

createdByEmailstring, (email)

Email of workspace creator

brandingobject(UserBranding)

User's branding configuration for video creation

Response
{
  "id": "693fb82afd8d1c43077ba0fe",
  "name": "My Workspace",
  "assetCount": 4,
  "projectCount": 3,
  "userCount": 1,
  "templateCount": 1,
  "createdByEmail": "info@shuffll.com",
  "branding": {
    "isDefault": true,
    "enabled": true,
    "company": { … },
    "logo": "/files/platform/onboarding/logo-placeholder.svg",
    "logoW": "/files/platform/onboarding/logo-placeholder.svg",
    "colors": { … },
    "pronunciations": []
  }
}