This resource represents customers, including their entitlements and customer detail fields.
Returns all customer detail fields, including their configuration. You can use the get customer
API to get details for a particular customer.
Permissions required: Administer Jira global permission.
read:customer.detail-field:jira-service-managementThis request has no parameters.
Returns list of detail fields.
1
2
3
4
curl --request GET \
--url 'https://your-domain.atlassian.net/api/v1/customer/details' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
"results": [
{
"name": "Region",
"type": {
"name": "SELECT",
"options": [
"AU",
"EU",
"US"
]
},
"configuration": {
"position": 1
}
}
]
}Creates a customer detail field. You can create up to 50 detail fields.
Permissions required: Administer Jira global permission.
write:customer.detail-field:jira-service-managementThe structure of the detail field to create.
string
RequiredDetailFieldType
RequiredReturns the newly created detail field.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
curl --request POST \
--url 'https://your-domain.atlassian.net/api/v1/customer/details' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"name": "Region",
"type": {
"name": "SELECT",
"options": [
"AU",
"EU",
"US"
]
}
}'1
2
3
4
5
6
7
8
9
10
11
{
"name": "Region",
"type": {
"name": "SELECT",
"options": [
"AU",
"EU",
"US"
]
}
}Renames a customer detail field and/or changes the available options for SELECT or MULTISELECT fields.
Permissions required: Administer Jira global permission.
write:customer.detail-field:jira-service-managementstring
Requiredstring
Requiredarray<string>
Returns the edited customer detail field.
1
2
3
4
5
6
7
8
9
10
11
12
13
curl --request PUT \
--url 'https://your-domain.atlassian.net/api/v1/customer/details/{fieldName}' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"name": "Region",
"options": [
"AU",
"EU",
"US"
]
}'1
2
3
4
5
6
7
8
9
10
11
{
"name": "Region",
"type": {
"name": "SELECT",
"options": [
"AU",
"EU",
"US"
]
}
}Deletes a customer detail field and all values stored for it for all customers. You cannot restore a detail field once it has been deleted.
Permissions required: Administer Jira global permission.
delete:customer.detail-field:jira-service-managementstring
RequiredReturns no response if the customer detail field is deleted.
1
2
3
curl --request DELETE \
--url 'https://your-domain.atlassian.net/api/v1/customer/details/{fieldName}' \
--header 'Authorization: Bearer <access_token>'Returns a customer, including their details. You can get entitlements for a customer using the get customer entitlements API.
Permissions required: Jira Service Management agent.
read:customer:jira-service-managementread:customer.detail:jira-service-managementstring
RequiredReturns the requested customer.
1
2
3
4
curl --request GET \
--url 'https://your-domain.atlassian.net/api/v1/customer/{customerId}' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'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
29
30
{
"id": "2a927c94-363f-4977-a0d6-9477d535f329",
"name": "John Doe",
"details": [
{
"id": "321",
"name": "Region",
"type": {
"name": "SELECT",
"options": [
"AU",
"EU",
"US"
]
},
"values": [
"EU"
],
"configuration": {
"position": 1
}
}
],
"organizations": [
{
"id": "123",
"name": "Atlassian"
}
]
}Permissions required: Jira Service Management agent.
write:customer.detail:jira-service-managementstring
Requiredstring
Requiredarray<string>
Returns the updated field.
1
2
3
4
5
6
7
8
9
10
curl --request PUT \
--url 'https://your-domain.atlassian.net/api/v1/customer/{customerId}/details?fieldName=Region' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"values": [
"EU"
]
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
{
"id": "321",
"name": "Region",
"type": {
"name": "SELECT",
"options": [
"AU",
"EU",
"US"
]
},
"values": [
"EU"
]
}Returns a list of the customer's entitlements, including entitlements inherited by any organizations the customer is in, along with their details.
Permissions required: Jira Service Management agent.
read:customer:entitlement:jira-service-managementstring
Requiredstring
Returns a list of entitlements.
array<Entitlement>
1
2
3
4
curl --request GET \
--url 'https://your-domain.atlassian.net/api/v1/customer/{customerId}/entitlement' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json'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
[
{
"id": "3858a61a-d337-42e6-993e-e13e1c366d4f",
"product": {
"id": "3858a61a-d337-42e6-993e-e13e1c366d4f",
"name": "Acme Widget"
},
"entitledEntity": {
"id": "123",
"type": "CUSTOMER"
},
"details": [
{
"id": "321",
"name": "Region",
"type": {
"name": "SELECT"
},
"values": [
"EU"
],
"configuration": {}
}
]
}
]Permissions required: Jira Service Management agent.
write:customer:entitlement:jira-service-managementstring
RequiredThe ID of the associated product.
string
RequiredReturns the created entitlement.
1
2
3
4
5
6
7
8
curl --request POST \
--url 'https://your-domain.atlassian.net/api/v1/customer/{customerId}/entitlement' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"productId": "3858a61a-d337-42e6-993e-e13e1c366d4f"
}'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
29
30
31
{
"id": "3858a61a-d337-42e6-993e-e13e1c366d4f",
"product": {
"id": "3858a61a-d337-42e6-993e-e13e1c366d4f",
"name": "Acme Widget"
},
"entitledEntity": {
"id": "123",
"type": "CUSTOMER"
},
"details": [
{
"id": "321",
"name": "Region",
"type": {
"name": "SELECT",
"options": [
"AU",
"EU",
"US"
]
},
"values": [
"EU"
],
"configuration": {
"position": 1
}
}
]
}Rate this page: