Tuyu Developers

Method Type

GET

Description

Retrieves all workspaces a user has access to.

URL

All responses are in JSON format by default, to specify an XML response add “.xml” to the end of the method name (in this case “workspace_list”)

https://<your subdomain>.<your domain>/api/workspace_list

Restrictions

There are no restrictions for this call.

Parameters

Bold indicates required. Please note parameters must be appended to the URL in alphabetical order, except for “signature”, which is always at the end.

Sample Response

Successful response In JSON:

{"workspaceList": {
    workspaces: [
        {
            "id":123,
            "workspaceName":"Workspace 1",
            "workspacePath":"/Workspace_1_workspace/",
            "listed":1
        },
        {
            "id":124,
            "workspaceName":"Workspace 2",
            "workspacePath":"/Workspace_2_workspace/",
            "listed":1
        }
    ],
    totalWorkspaces: 2 
}}

Successful response in XML:

<workspaceList>
    <workspaces>
        <workspace>
            <id>16019</id>
            <workspaceName>APEX Systems</workspaceName>
            <workspacePath>/APEX_Systems_workspace/</workspacePath>
            <listed>1</listed>
        </workspace>
        <workspace>
            <id>15927</id>
            <workspaceName>Archives 2009</workspaceName>
            <workspacePath>/Archives_2009_workspace/</workspacePath>
            <listed>1</listed>
        <workspace>
    </workspaces>
    <totalWorkspaces>2</totalWorkspaces>
</workspaceList>

Error response In JSON:

{"error":{
    "title":""Workspace Listing Failed",
    "message":"You must be an administrator to call this method"}
}

Error response In XML:

<error>
    <title>'Workspace Listing Failed</title>
    <message>You must be an administrator to call this method</message>
</error>