Workspace Listing (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://<yoursubdomain>.filetransfers.net/api/workspace_list

Restrictions

There are no restrictions for this call.

Parameters

Bold indicates required.

Parameter	Description
api_key	Your API Key.
timestamp	The current time in Unix timestamp format.
signature	Please see "User Authentication" for more information.

Sample Response

Unlike a file listing or a search in a specific location, a search across the entire site returns a set of permissions for each file/folder. Please use these to determine whether a user can perform an action on a result.

Successful response In JSON:

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

Successful response in XML:

<workspaceList>
	<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>
</workspaceList>