This resource represents organizations. Use this to manage an organization, profile, detail fields and values, entitlements and customers they have.
Returns all organization detail fields, including their configuration. You can use the get organization profile API to get details for a particular organization.
Permissions required: Administer Jira global permission.
read:organization.detail-field:jira-service-managementThis request has no parameters.
Returns a list of organization detail fields.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jsm/csm/cloudid/{cloudId}/api/v1/organization/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 an organization detail field. You can create up to 50 detail fields.
Permissions required: Administer Jira global permission.
write:organization.detail-field:jira-service-managementstring
RequiredDetailFieldType
RequiredReturns the created detail field.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
curl --request POST \
--url 'https://api.atlassian.com/jsm/csm/cloudid/{cloudId}/api/v1/organization/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 an organization detail field and/or changes the available options for SELECT or MULTISELECT fields.
Permissions required: Administer Jira global permission.
write:organization.detail-field:jira-service-managementstring
Requiredstring
Requiredarray<string>
Returns the edited organization detail field.
1
2
3
4
5
6
7
8
9
10
11
12
13
curl --request PUT \
--url 'https://api.atlassian.com/jsm/csm/cloudid/{cloudId}/api/v1/organization/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 an organization detail field and all values stored for it for all organizations. You cannot restore a detail field once it has been deleted.
Permissions required: Administer Jira global permission.
delete:organization.detail-field:jira-service-managementstring
RequiredReturns no response if the organization detail field is deleted.
1
2
3
curl --request DELETE \
--url 'https://api.atlassian.com/jsm/csm/cloudid/{cloudId}/api/v1/organization/details/{fieldName}' \
--header 'Authorization: Bearer <access_token>'Returns an organization, including its details.
It is recommended to use the get organization profile API which is a simpler response shape to work with and also includes the entitlements for the organization.
Permissions required: Jira Service Management agent.
read:organization:jira-service-managementread:organization.detail:jira-service-managementstring
RequiredReturns the requested organization.
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jsm/csm/cloudid/{cloudId}/api/v1/organization/{organizationId}' \
--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
{
"id": "123",
"name": "Atlassian",
"details": [
{
"id": "321",
"name": "Region",
"type": {
"name": "SELECT",
"options": [
"AU",
"EU",
"US"
]
},
"values": [
"EU"
],
"configuration": {
"position": 1
}
}
]
}Updates an organization's name.
Permissions required: Customer Service Management or Jira Service Management user. Note: Permission to update organizations can be switched to users with the Administer Jira global permission permission using the Organization management feature available in Jira Service Management product settings.
write:organization:jira-service-managementstring
RequiredExperimentalHeader
Requiredstring
RequiredReturns the updated organization.
This represents the ID and name of the organizations which the individual are members of.
1
2
3
4
5
6
7
8
9
curl --request PUT \
--url 'https://api.atlassian.com/jsm/csm/cloudid/{cloudId}/api/v1/organization/{organizationId}' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json' \
--header 'X-ExperimentalApi: opt-in' \
--header 'Content-Type: application/json' \
--data '{
"name": "Atlassian"
}'1
2
3
4
{
"id": "123",
"name": "Atlassian"
}Permissions required: Jira Service Management agent.
write:organization.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://api.atlassian.com/jsm/csm/cloudid/{cloudId}/api/v1/organization/{organizationId}/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 organization's entitlements, along with their details.
Permissions required: Jira Service Management agent.
read:organization:entitlement:jira-service-managementstring
Requiredstring
Returns a list of entitlements.
array<Entitlement>
1
2
3
4
curl --request GET \
--url 'https://api.atlassian.com/jsm/csm/cloudid/{cloudId}/api/v1/organization/{organizationId}/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:organization:entitlement:jira-service-managementstring
RequiredThe ID of the associated product, as a UUID.
string
RequiredReturns the created entitlement.
1
2
3
4
5
6
7
8
curl --request POST \
--url 'https://api.atlassian.com/jsm/csm/cloudid/{cloudId}/api/v1/organization/{organizationId}/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
}
}
]
}Creates an organization.
Permissions required: Customer Service Management or Jira Service Management user. Note: Permission to create organizations can be switched to users with the Administer Jira global permission permission using the Organization management feature available in Jira Service Management product settings.
write:organization:jira-service-managementExperimentalHeader
Requiredstring
RequiredReturns the created organization.
This represents the ID and name of the organizations which the individual are members of.
1
2
3
4
5
6
7
8
9
curl --request POST \
--url 'https://api.atlassian.com/jsm/csm/cloudid/{cloudId}/api/v1/organization' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json' \
--header 'X-ExperimentalApi: opt-in' \
--header 'Content-Type: application/json' \
--data '{
"name": "Atlassian"
}'1
2
3
4
{
"id": "123",
"name": "Atlassian"
}Returns a maximum of 50 organizations, fetched by organization id or name.
Any organizations that cannot be found will be omitted from the results.
Permissions required: Customer Service Management or Jira Service Management user.
read:organization:jira-service-managementExperimentalHeader
Requiredarray<string>
array<string>
Returns the requested organizations, if existing.
Response containing the list of requested organizations.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
curl --request POST \
--url 'https://api.atlassian.com/jsm/csm/cloudid/{cloudId}/api/v1/organization/fetch' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json' \
--header 'X-ExperimentalApi: opt-in' \
--header 'Content-Type: application/json' \
--data '{
"organizationIds": [
"1",
"2"
],
"organizationNames": [
"Atlassian"
]
}'1
2
3
4
5
6
7
8
{
"organizations": [
{
"id": "123",
"name": "Atlassian"
}
]
}Returns a organization's profile, including its custom details and any product entitlements.
Permissions required: Customer Service Management or Jira Service Management user.
read:organization.profile:jira-service-managementstring
RequiredExperimentalHeader
RequiredReturns the requested organization profile.
1
2
3
4
5
curl --request GET \
--url 'https://api.atlassian.com/jsm/csm/cloudid/{cloudId}/api/v1/organization/profile/{organizationId}' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json' \
--header 'X-ExperimentalApi: opt-in'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
32
33
34
35
36
37
38
39
40
41
42
43
44
{
"id": "1",
"name": "Atlassian",
"details": [
{
"name": "Region",
"value": {
"type": "SELECT",
"text": [
"EU"
]
}
}
],
"entitlements": [
{
"id": "3858a61a-d337-42e6-993e-e13e1c366d4f",
"product": {
"id": "3858a61a-d337-42e6-993e-e13e1c366d4f",
"name": "Acme Widget"
},
"entitledEntity": {
"id": "123",
"type": "CUSTOMER"
},
"details": [
{
"name": "Region",
"value": {
"type": "SELECT",
"text": [
"EU"
]
}
}
]
}
],
"customers": [
{
"id": "qm:9edf598a-85d4-4db9-bf2e-7245922b4ea8:0000e9d8-a22e-4220-ac63-412ff9eec053"
}
]
}Creates an organization's profile, including adding the organization's detail fields, customers belonging to the organization and any product entitlements.
Permissions required: Customer Service Management or Jira Service Management user. Note: Permission to create organizations can be switched to users with the Administer Jira global permission permission using the Organization management feature available in Jira Service Management product settings.
write:organization.profile:jira-service-managementExperimentalHeader
Requiredstring
Requiredarray<ProfileDetailFieldValueRequest>
AssociateCustomers
AssociateProducts
Returns the created organization profile.
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
curl --request POST \
--url 'https://api.atlassian.com/jsm/csm/cloudid/{cloudId}/api/v1/organization/profile' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json' \
--header 'X-ExperimentalApi: opt-in' \
--header 'Content-Type: application/json' \
--data '{
"name": "Atlassian",
"details": [
{
"name": "Region",
"values": [
"EU"
]
}
],
"associateCustomers": {
"customerIds": [
"qm:9edf598a-85d4-4db9-bf2e-7245922b4ea8:0000e9d8-a22e-4220-ac63-412ff9eec053",
"qm:10c2e972-eef6-4e0e-aa81-9a9e7a4ba9a7:3468699a-b2f0-4ae9-ab2d-155a5f5a8db4"
]
},
"associateProducts": {
"productIds": [
"3858a61a-d337-42e6-993e-e13e1c366d4f",
"4858a61a-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
32
33
34
35
36
37
38
39
40
41
42
43
44
{
"id": "1",
"name": "Atlassian",
"details": [
{
"name": "Region",
"value": {
"type": "SELECT",
"text": [
"EU"
]
}
}
],
"entitlements": [
{
"id": "3858a61a-d337-42e6-993e-e13e1c366d4f",
"product": {
"id": "3858a61a-d337-42e6-993e-e13e1c366d4f",
"name": "Acme Widget"
},
"entitledEntity": {
"id": "123",
"type": "CUSTOMER"
},
"details": [
{
"name": "Region",
"value": {
"type": "SELECT",
"text": [
"EU"
]
}
}
]
}
],
"customers": [
{
"id": "qm:9edf598a-85d4-4db9-bf2e-7245922b4ea8:0000e9d8-a22e-4220-ac63-412ff9eec053"
}
]
}Returns a maximum of 25 organization profiles.
Any organizations that cannot be found will be omitted from the results.
Permissions required: Customer Service Management or Jira Service Management user.
read:organization.profile:jira-service-managementExperimentalHeader
Requiredarray<string>
array<string>
array<string>
Returns the requested organization profiles, if existing.
Response containing the list of requested profiles.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
curl --request POST \
--url 'https://api.atlassian.com/jsm/csm/cloudid/{cloudId}/api/v1/organization/profile/fetch' \
--header 'Authorization: Bearer <access_token>' \
--header 'Accept: application/json' \
--header 'X-ExperimentalApi: opt-in' \
--header 'Content-Type: application/json' \
--data '{
"organizationIds": [
"1",
"2"
],
"organizationNames": [
"Atlassian"
]
}'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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
{
"profiles": [
{
"id": "1",
"name": "Atlassian",
"details": [
{
"name": "Region",
"value": {
"type": "SELECT",
"text": [
"EU"
]
}
}
],
"entitlements": [
{
"id": "3858a61a-d337-42e6-993e-e13e1c366d4f",
"product": {
"id": "3858a61a-d337-42e6-993e-e13e1c366d4f",
"name": "Acme Widget"
},
"entitledEntity": {
"id": "123",
"type": "CUSTOMER"
},
"details": [
{
"name": "Region",
"value": {
"type": "SELECT",
"text": [
"EU"
]
}
}
]
}
],
"customers": [
{
"id": "qm:9edf598a-85d4-4db9-bf2e-7245922b4ea8:0000e9d8-a22e-4220-ac63-412ff9eec053"
}
]
}
]
}Rate this page: