Skip to content
/Organizations

Organizations

Manage organizations and retrieve their workspaces, branding, and settings.

Operations

Get organization list

Request

Retrieve array of all organizations the user has access to.

Returns metadata for each organization including:

  • Organization ID and name
  • Workspaces within each organization
  • Branding configuration (colors, logos, company info)
  • Video prompts and ideas
  • User access status and user count
Security
ShuffllApiKey
curl -i -X GET \
  https://api-docs.shuffll.com/_mock/apis/auth/organization/list \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Successfully retrieved organization list.

Bodyapplication/json
Array [
idstring

Unique organization identifier

Example:"693fb82afd8d1c43077ba0fb"
namestring

Organization name

Example:"My Organization"
workspacesArray of objects

List of workspaces in this organization

brandingobject(UserBranding)

User's branding configuration for video creation

createdByEmailstring, (email)

Email of organization creator

isAllowedToUseOrganizationboolean

Whether user can use this organization

userCountinteger

Number of users in organization

isDefaultForUserboolean

Whether this is the user's default organization

]
Response
[
  {
    "id": "693fb82afd8d1c43077ba0fb",
    "name": "My Organization",
    "workspaces": [ … ],
    "branding": { … },
    "createdByEmail": "info@shuffll.com",
    "isAllowedToUseOrganization": true,
    "userCount": 1,
    "isDefaultForUser": true
  }
]