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

Most of the time, the serviceDeskId parameter will coincide with the portalId parameter on a particular Jira Service Management project. However, this might not be the case if your service project was created before 2017, as in earlier versions of Jira Service Management, you could have Service Desks without Portals or some contention issues when creating two or more Jira Service Management projects at the same time, resulting in the IDs not having the same value.

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

1. Open your Service Project.

2. Go to Project settings > Channels & Self service > Portal.

3. You'll get the portalId (serviceDeskId) from the Portal URL field (for example, for https://<domain>.atlassian.net/servicedesk/customer/portal/3, the serviceDeskId will be 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 Project.

2. Go to Project settings.

3. Make sure to have the Network within the Developer tools of your browser recording the Network traffic. Instructions on how to do this are here.

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 project key (for example in the screenshot below the project key is J1). From where you'll be able to dig the serviceDeskId (you'll also be able to see the portalId as a different field).

   

Using the API

• Use the API's Get service desks method to determine the serviceDeskId related to a particular project 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 project, 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 Project 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 project, you'll need to use https://<domain>.atlassian.net/rest/servicedeskapi/servicedesk/HR endpoint.