API documentation

GetUserWorkspaces

Inputs (optional)

uid 'string(40)'

A unique user identifier (as provided by PBworks)

archived 'bool'

Include archived workspaces in the results (default true)

personal 'bool'

Include other people's personal workspaces in the results (default true)

my_personal 'bool'

Include your personal workspace in the results (default true)

parents 'bool'

Include an array of parent workspace collections, that represent the hierarchy to this workspace (default false)

filter 'string'

Filter the names or descriptions of workspaces

perm 'string'

A permission description: {admin,edit,write,read,page,deny}

count 'int'

Maximum number of records to return

offset 'int'

Number of records to skip

type_id 'string'

Include only workspaces of the specified type_id

workspaces 'array'

List of workspaces

count 'string'

Number of workspaces returned

total_count 'int'

Total number of workspaces

Quantcast