Retrieving the custom field values for the users
- David Claudia
On this page
The value of the custom fields for a specific Jira user can be retrieved programmatically by using the REST API method below.
Request URL
The request URL takes the following form:
https:/ /MY_Jira_BASE_URL/rest/api/3/user/properties/CUSTOM_FIELD_ID?accountId=USER_ACCOUNT_ID&jsonValue=true
Replace "http:/ /MY_Jira_BASE_URL" with the base URL of your Jira server and the parameters as described below.
Parameters
You have to specify the following parameters:
Parameter | Description |
|---|---|
CUSTOM_FIELD_ID | The ID of the user custom field for which you want to retrieve the value. See Determining the ID of a custom field for how to determine the ID of the field. |
USER_ACCOUNT_ID | The accountId of the Jira user for which you want to retrieve the value. |
An example of the request URL with parameters is as follows:
https:/ /myjira.atlassian.net/rest/api/3/user/properties/1667729115557?accountId=557058%3A682699a7-c8dd-4c7a-bc1f-00972ca096c4&jsonValue=true
In this example the value of field with id "1667729115557" of the user with account id 557058%3A682699a7-c8dd-4c7a-bc1f-00972ca096c4 is retrieved.
A successful response
An HTTP 200 status response indicates a successful request. The following data about the matching documents is returned in JSON format:
{"key":"1667729115557","value":{"value":"Programmer","customFieldId":1667729115557}}Error Response
If the REST call fails, the service returns one of the following HTTP statuses:
HTTP Status Code | Description |
|---|---|
400 | Returned if the user key or id is invalid. |
401 | Returned if the calling user is not authenticated. |
403 | Returned if the calling user does not have permission to browse the user. |
404 | Returned if the user with given key does not exist or if the specified field ID does not exist. |