Customer
Info
Insight
Knowledgebase
Organization
Request
Requesttype
Servicedesk

Rate this page:

Insight

Get insight workspaces

GET /rest/servicedeskapi/insight/workspace

Returns a list of Insight workspace IDs. Include a workspace ID in the path to access the Insight REST APIs.

Permissions required: Any

Connect apps cannot access this REST resource.

OAuth scopes required
read:servicedesk-request

Request

Query parameters
start

integer

The starting index of the returned workspace IDs. Base index: 0 See the Pagination section for more details.

Default: 0, Format: int32
limit

integer

The maximum number of workspace IDs to return per page. Default: 50 See the Pagination section for more details.

Default: 50, Format: int32

Example

1
2
3
4
curl --request GET \
  --url 'https://your-domain.atlassian.net/rest/servicedeskapi/insight/workspace' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

Returned if the request is successful.

Content typeValue
application/json

PagedDTOInsightWorkspaceDTO

Example response (application/json)

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
  "_expands": [],
  "size": 1,
  "start": 1,
  "limit": 1,
  "isLastPage": true,
  "_links": {
    "base": "https://your-domain.atlassian.net/rest/servicedeskapi",
    "context": "context",
    "next": "https://your-domain.atlassian.net/rest/servicedeskapi/rest/servicedeskapi/insight/workspace?start=2&limit=1",
    "prev": "https://your-domain.atlassian.net/rest/servicedeskapi/rest/servicedeskapi/insight/workspace?start=0&limit=1"
  },
  "values": [
    {
      "workspaceId": "1060ba0e-178b-4e0e-g0h1-jedb02cccb5f"
    }
  ]
}

Rate this page: