• Organization
  • Customer
Cloud
Customer Service Management / / REST API

Customer

Postman Collection
OpenAPI
GET

Get a customer by id

Returns a Customer, including their details.

read:customer:jira-service-management
,
read:customer.detail:jira-service-management

Request

Path parameters

customerId

CustomerId

Required

Responses

Returns the requested individual.

application/json

Customer
GET/api/v1/customer/{customerId}
1 2 3 4 curl --request GET \ --url '{host}/{basePath}/api/v1/customer/{customerId}' \ --header 'Authorization: Bearer <access_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 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": 41 } } ], "organizations": [ { "id": "123", "name": "Atlassian" } ] }
PUT

Update the value of a detail field for a given customer

Updates and returns the new value(s) of the updated field, along with its general configuration (such as ID and Type).

write:customer.detail-field:jira-service-management

Request

Path parameters

customerId

CustomerId

Required

Query parameters

fieldName

string

Required

Request bodyapplication/json

The value(s) of the field to update.

Min properties: 1
values

array<string>

Responses

On success, returns the updated field value(s).

application/json

UpdateDetailFieldResponse
PUT/api/v1/customer/{customerId}/details
1 2 3 4 5 6 7 8 9 10 curl --request PUT \ --url '{host}/{basePath}/api/v1/customer/{customerId}/details?fieldName=Region' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data '{ "values": [ "EU" ] }'
200Response
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" ] }

Rate this page: