Skip to content
/Workspaces

List accessible workspaces with pagination

Request

Security
ShuffllApiKey
Path
organizationIdstringrequired

Unique identifier for the organization

Example:693fb82afd8d1c43077ba0fb
Query
pageinteger, >= 1
Default:1
limitinteger, >= 1
Default:10
searchstring

Search workspace names.

curl -i -X GET \
  'https://api-docs.shuffll.com/_mock/apis/auth/organization/693fb82afd8d1c43077ba0fb/workspace/list?page=1&limit=10&search=string' \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Accessible workspaces and pagination

Bodyapplication/json
workspacesArray of objects(WorkspaceDetail)
paginationobject(Pagination)
Response
{
  "workspaces": [
    { … }
  ],
  "pagination": {
    "page": 0,
    "limit": 0,
    "total": 0,
    "totalPages": 0,
    "hasMore": true
  }
}