Cloud

Customer Service Management / Reference / REST API

Product

This resource represents products.

Operations

GET/api/v1/product POST/api/v1/product GET/api/v1/product/{productId}PUT/api/v1/product/{productId}DEL/api/v1/product/{productId}

GET

Get products

Permissions required: Jira Service Management agent.

OAuth 2.0 scopes required:

read:product:jira-service-management

Request

Query parameters

limit

integer

cursor

string

Responses

Returns paginated list of products.

application/json

PaginatedProducts

GET/api/v1/product

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url 'https://your-domain.atlassian.net/api/v1/product' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

200Response

{
  "results": [
    {
      "id": "3858a61a-d337-42e6-993e-e13e1c366d4f",
      "name": "Acme Widget"
    }
  ],
  "nextPageCursor": "<string>"
}

POST

Create product

Permissions required: Jira Service Management agent.

OAuth 2.0 scopes required:

write:product:jira-service-management

Request

Request bodyapplication/json

The name of the product.

name

string

Required

Responses

Returns the created product.

application/json

Product

POST/api/v1/product

curl

Node.js

Java

Python

PHP

curl --request POST \
  --url 'https://your-domain.atlassian.net/api/v1/product' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Acme Widget"
}'

200Response

{
  "id": "3858a61a-d337-42e6-993e-e13e1c366d4f",
  "name": "Acme Widget"
}

GET

Get product

Permissions required: Jira Service Management agent.

OAuth 2.0 scopes required:

read:product:jira-service-management

Request

Path parameters

productId

string

Required

Responses

Returns the requested product.

application/json

Product

GET/api/v1/product/{productId}

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url 'https://your-domain.atlassian.net/api/v1/product/{productId}' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

200Response

{
  "id": "3858a61a-d337-42e6-993e-e13e1c366d4f",
  "name": "Acme Widget"
}

PUT

Rename product

Permissions required: Jira Service Management agent.

OAuth 2.0 scopes required:

write:product:jira-service-management

Request

Path parameters

productId

string

Required

Request bodyapplication/json

The new name of the product.

name

string

Required

Responses

Returns the updated product.

application/json

Product

PUT/api/v1/product/{productId}

curl

Node.js

Java

Python

PHP

curl --request PUT \
  --url 'https://your-domain.atlassian.net/api/v1/product/{productId}' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Acme Widget"
}'

200Response

{
  "id": "3858a61a-d337-42e6-993e-e13e1c366d4f",
  "name": "Acme Widget"
}

DEL

Delete product

Deletes a product and all entitlements associated with it. You cannot restore a detail field once it has been deleted.

Permissions required: Administer Jira global permission.

OAuth 2.0 scopes required:

delete:product:jira-service-management

Request

Path parameters

productId

string

Required

Responses

On success, returns no response.

DEL/api/v1/product/{productId}

curl

Node.js

Java

Python

PHP

1
2
3

curl --request DELETE \
  --url 'https://your-domain.atlassian.net/api/v1/product/{productId}' \
  --header 'Authorization: Bearer <access_token>'