Skip to content
API Reference/
/
Get specific organization

Get specific organization

Request

Retrieve detailed information about a specific organization including:

  • Organization ID and name
  • All workspaces with detailed metrics (asset count, project count, template count)
  • Complete branding configuration
  • User information
Security
ShuffllApiKey
Path
organizationIdstringrequired

Unique identifier for the organization

Example:693fb82afd8d1c43077ba0fb
Query
limitinteger

Maximum workspaces embedded in this response.

Default:10
curl -i -X GET \
  'https://api-docs.shuffll.com/_mock/apis/auth/organization/693fb82afd8d1c43077ba0fb?limit=10' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successfully retrieved organization details.

Bodyapplication/json
idstring

Unique organization identifier

Example:"693fb82afd8d1c43077ba0fb"
namestring

Organization name

Example:"My Organization"
workspacesArray of objects(WorkspaceDetail)

First page of accessible workspaces. Use the paginated workspace list endpoint to enumerate the rest.

brandingobject(UserBranding)

User's branding configuration for video creation

createdByEmailstring, (email)

Email of organization creator

userCountinteger

Number of users in organization

workspacesMetaobject
Response
{
  "id": "693fb82afd8d1c43077ba0fb",
  "name": "My Organization",
  "workspaces": [
    { … }
  ],
  "branding": {
    "isDefault": true,
    "enabled": true,
    "company": { … },
    "logo": "/files/platform/onboarding/logo-placeholder.svg",
    "logoW": "/files/platform/onboarding/logo-placeholder.svg",
    "colors": { … },
    "pronunciations": []
  },
  "createdByEmail": "info@shuffll.com",
  "userCount": 1
}