This is the reference for the Jira Customer Service Management Cloud REST APIs. The REST APIs are for developers who want to integrate Jira Customer Service Management with other applications or administrators that want to automate their workflows and processes.
If you are integrating directly with the Customer Service Management (CSM) REST APIs it is recommended to use OAuth 2.0 authorization code grants (3LO) method.
For implementations with low security requirements, such as scripts and bots, it is also possible to use Basic authentication method.
Support for Atlassian Connect app to interact with the CSM APIs is currently unavailable.
Jira Customer Service Management is built upon the Jira platform, and Jira Service Management product. As such, in Jira Customer Service Management you have access to the Jira platform and Jira Service Management REST APIs.
If you are writing an Atlassian Connect app, your app can request access to the Jira platform REST APIs by using the correct Jira platform Connect Scopes.
Permissions control the level of a user's access to the Jira Customer Service Management instance, while roles are how the permissions are assigned to individual users.
The Jira Customer Service Management REST API enable you to work with a range of objects from Jira Customer Service Management. The main resources provided are:
|This resource represents customers within your Jira instance. It allows for the retrieval and updating of detail fields for customers.
|This resource enables you to group Jira Customer Service Management customers together. It allows for the retrieval and updating of detail fields for organizations.
Scopes provide static authorization for Atlassian Connect apps. If you are using your own credentials to make REST calls, then these scopes do not apply.
Scopes are defined in the Connect app descriptor and specify the maximum set of actions that an app may perform: read, write, etc. This security level is enforced by Atlassian Connect and cannot be bypassed by app implementations.
The base URL is composed by a and a followed by a specific endpoint path. The is always https://api.atlassian.com while the is , where is the id of your cloud instance.
For example, to retrieve an organization with id 123 from an instance with cloudId , the URL would look like:
To find your cloudId follow the instructions on this page
This documentation is for Version 1 of the Customer Service Management (CSM) REST API, which is the latest version.