Find the service desk ID for your Jira Service Management Cloud project

Summary

Many endpoints within the Jira Service Management Cloud REST API require the serviceDeskId as a parameter. Learn how to find this ID via UI and API.

Solution

Using the Jira User Interface

For most spaces, the serviceDeskId equals the portalId, which you can read straight from the Portal URL. (Exception: spaces created before 2017, or ID contention when creating multiple spaces at once, can make them differ.)

To find the portalId (which most of the time coincide with the serviceDeskId) via the UI, you can simply:

1. Space settings > Channels & Self service > Portal.

2. Read the ID from the Portal URL — e.g. https://<domain>.atlassian.net/servicedesk/customer/portal/3 means serviceDeskId = 3.

Browser developer tools

In order to be 100% sure to get the correct serviceDeskId, you can always use the Network within the Developer tools of your browser to check the API requests Jira makes internally to load the content of the [https://<domain>.atlassian.net/jira/servicedesk/projects/pkey/settings/portal-settings] page in the UI explained above.

1. Open your Service Space.

2. Go to Space settings.

3. Make sure the Network tab in your browser's Developer tools is traffic.

4. Go to Channels & Self service and click on Portal.

5. Check the Network logs, and you'll be able to identify a GET HTTP request to an endpoint similar to https://<domain>.atlassian.net/rest/servicedesk/1/pages/agent/servicedesk/pkey with the name of your space key.

Using the API

• Use the API's Get service desks method to determine the serviceDeskId related to a particular space by checking the id parameter of the resulting payload.

• By issuing a GET HTTP request to the Get service desks method, you'll receive a payload from which you'll be able to use the projectName or projectKey under each different entry of the values array to identify the service space, and the id to identify the relevant serviceDeskId.

  { "_expands": [], "size": 3, "start": 3, "limit": 3, "isLastPage": false, "_links": { "base": "https://<domain>.atlassian.net/rest/servicedeskapi", "context": "context", "next": "https://<domain>.atlassian.net/rest/servicedeskapi/servicedesk?start=6&limit=3", "prev": "https://<domain>.atlassian.net/rest/servicedeskapi/servicedesk?start=0&limit=3" }, "values": [ { "id": "12", "projectId": "11001", "projectName": "IT Help Desk", "projectKey": "ITH", "_links": { "self": "https://<domain>.atlassian.net/rest/servicedeskapi/servicedesk/10001" } } ] }

• You can use it directly in the browser by pasting the URL https://<domain>.atlassian.net/rest/servicedeskapi/servicedesk.

  {"id":"12", "projectId":"10030", "projectName":"Service Desk IT", "projectKey":"IT", "_links":{"self":"https://<domain>.atlassian.net/rest/servicedeskapi/servicedesk/12"}}]}

• You can also use the Space Key or the Project ID in an API request to the Get service desk by id.

  • For example, to get the serviceDeskId for the HR space, you'll need to use the endpoint https://<domain>.atlassian.net/rest/servicedeskapi/servicedesk/HR.