Workspaces

Retrieving workspaces

To retrieve a list of workspaces from the developers.whispir.com API you can execute a HTTP GET using the /workspaces endpoint.

You need to supply one of the following headers (for retrieving JSON or XML):

  • Accept: application/vnd.whispir.workspace-v1+xml
  • Accept: application/vnd.whispir.workspace-v1+json

An array of workspaces will be returned to you in the HTTP response body. Each workspace will provide the following information:

High-level response elements

projectName

String

Specifies the name of the workspace to be created.

projectNumber

String

Specifies the reference ID for the workspace from the user side. Generally not used.

Note: This is not the actual workspace ID. It’s just a custom reference ID given by you for your own purposes.

status

String

Specifies the status of the workspace being created. The status can be either:

  • Active (A)
  • Disabled (D)

billingcostcentre

String

Allows the user to set a billing cost centre for the workspace.

Note: This is only applicable to customers with the Billing Cost Centre module enabled.

link

Array

Provides a list of URLs that can be used to manipulate or access the workspace.

  • uri: The link to access the workspace.
  • rel: The descriptor for what the link will do.
  • method: The HTTP method to use with this particular link.

  • JSON
  • XML

{{codeStart}}

HTTP 1.1 GET https://api.<region>.whispir.com/workspaces?apikey=[your_api_key]

Authorization: Basic asdf98nf89asdvasd2r398h8sdf

x-api-key: your_api_key

Accept: application/vnd.whispir.workspace-v1+json

{

"workspaces": [

{

"id": "7311ABEB701E7C60",

"projectName": "Sales Lead Notifications",

"projectNumber": "",

"status": "A",

"billingcostcentre": "0",

"link": [

{

"uri": "https://api.<region>.whispir.com/workspaces/7311ABEB701E7C60?apikey=[your_api_key]",

"rel": "self",

"method": "GET"

}

]

},

{

"id": "26B1A09C1FEC20A2",

"projectName": "Product Release Management",

"projectNumber": "",

"status": "A",

"billingcostcentre": "0",

"link": [

{

"uri": "https://api.<region>.whispir.com/workspaces/26B1A09C1FEC20A2?apikey=[your_api_key]",

"rel": "self",

"method": "GET"

}

]

},

{

"id": "A358845BF004C113",

"projectName": "Business Working Group",

"projectNumber": "",

"status": "A",

"billingcostcentre": "CLSA",

"link": [

{

"uri": "https://api.<region>.whispir.com/workspaces/A358845BF004C113?apikey=[your_api_key]",

"rel": "self",

"method": "GET"

}

]

},

{

"id": "B7BFEF555F0F7F81",

"projectName": "Critical Incident Management",

"projectNumber": "",

"status": "A",

"billingcostcentre": "",

"link": [

{

"uri": "https://api.<region>.whispir.com/workspaces/B7BFEF555F0F7F81?apikey=[your_api_key]",

"rel": "self",

"method": "GET"

}

]

}

]

}

{{codeEnd}}