Intralinks Developer Portal

Getting Started | Community Forums | FAQs |

Get Workspaces

Retrieve a list and metadata of all workspaces visible to the user.

 

Resource Location

GET /services/workspaces

 

Authorization Type

HTTP Cookie ssoGlobalSessionID

 

Request Parameters

Name Description Format Required Default Example
method Intralinks call method. Must be set to GET string yes none method=GET
workspaceId Filter results to a particular workspace. If an invalid workspaceId is specified, the API will return metadata for all accessible exchanges. long no If not specified, API will retrieve metadata for all accessible exchanges. n/a
phase Filter results by exchange "phase"
HOLD,PREPARATION,OPEN,DELETED		 string no All non-deleted exchanges are retrieved &phase=OPEN

Example Request

curl -k -X GET
-b "ssoGlobalSessionID=SESSION_ID" “https://test-api.intralinks.com/services/workspaces?method=GET&client=THE_CLIENT_ID&workspaceId=THE_WORKSPACE_ID&phase=OPEN”

Example Response

<workspaceResponse>
  <workspace>
    <id>1</id>
    <workspaceName>Test Workspace</workspaceName>
    <phase>OPEN</phase>
    <description>My Workspace</description>
    <parentTemplateId>2345</parentTemplateId>
    <host>intralinks</host>
      ………
    <customFields>
       <field>
          <id>1708680008</id>
          <value>Value1</value>
       </field>
       <field>
          <id>1708685008</id>
          <value>Cardiology</value>
       </field>
       <field>
          <id>1708663008</id>
          <value>Safety</value>
       </field>
    </customFields>
    <pvpEnabled>F</pvpEnabled>
    <industryCodeValue>CUSIP1321</industryCodeValue>
  <workspace>
<workspaceResponse>