• Approval
  • Customer
  • Customer Request
  • Customer Transition
  • Jira Service Management Application
  • Organization
  • Organization Service Desk
  • Portals
  • Queue
  • Queue Settings
  • Request Attachment
  • Request Type
  • Request Type Permissions
  • Service Desk
  • Service Desk Customer
  • application-properties
  • applicationrole
  • attachment
  • avatar
  • cluster
  • comment
  • component
  • configuration
  • customFieldOption
  • customFields
  • dashboard
  • email-templates
  • field
  • filter
  • group
  • groups
  • groupuserpicker
  • index
  • index-snapshot
  • issue
  • issueLinkType
  • issuesecurityschemes
  • issuetype
  • issuetypescheme
  • jql
  • licenseValidator
  • monitoring
  • mypermissions
  • mypreferences
  • myself
  • notificationscheme
  • password
  • permissions
  • permissionscheme
  • priority
  • priorityschemes
  • project
  • projectCategory
  • projects
  • projectvalidate
  • reindex
  • resolution
  • role
  • screens
  • securitylevel
  • serverInfo
  • session
  • settings
  • status
  • statuscategory
  • terminology
  • universal_avatar
  • upgrade
  • user
  • version
  • websudo
  • workflow
  • workflowscheme
  • worklog
  • Assets - AQL
  • Assets - Analytics
  • Assets - Archived Objects
  • Assets - Attachments
  • Assets - Comments
  • Assets - Icons
  • Assets - Index Configuration
  • Assets - Object
  • Assets - Object Archive
  • Assets - Object Attribute
  • Assets - Object Connected Tickets
  • Assets - Object Restore
  • Assets - Object Schema
  • Assets - Object Type
  • Assets - Object Type Attribute
  • Assets - Progress
  • Assets - QR Code
  • Assets - Status Types
Server
Jira Service Management / Reference / REST API

Service Desk

Postman Collection
OpenAPI
GET

Get service project by ID

Returns the service project for a given service project Id.

Forge and OAuth2 apps cannot access this REST resource.

Request

Path parameters

serviceDeskId

string

Required

Responses

Returns the requested service project.

application/json

ServiceDeskDTO
GET/servicedeskapi/servicedesk/{serviceDeskId}
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/servicedeskapi/servicedesk/{serviceDeskId}' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 { "id": "<string>", "projectId": "<string>", "projectName": "<string>", "projectKey": "<string>", "_links": { "self": "<string>", "portal": "<string>" } }
GET

Get service projects

Returns all service projects in the Jira Service Management application with the option to include archived service projects.

Forge and OAuth2 apps cannot access this REST resource.

Request

Query parameters

includeArchived

string

start

number

limit

number

Responses

Returns the service projects, at the specified page of the results.

application/json

object
GET/servicedeskapi/servicedesk
1 2 3 4 curl --request GET \ --url 'http://{baseurl}/rest/servicedeskapi/servicedesk' \ --user 'email@example.com:<api_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 { "_expands": [ "<string>" ], "size": 1, "start": 0, "limit": 50, "isLastPage": true, "_links": { "base": "<string>", "context": "<string>", "next": "<string>", "prev": "<string>", "self": "<string>" }, "values": [ { "id": "<string>", "projectId": "<string>", "projectName": "<string>", "projectKey": "<string>", "_links": { "self": "<string>", "portal": "<string>" } } ] }

Rate this page: