Retrieving the value of a specific custom field for a user

On this page

Use this method to retrieve the value of a specific custom field for a specified Jira user.

To retrieve the data using this method, you must be authenticated with a user that has permissions to edit the custom fields of other users. See Configuring the app permissions.

Request URL

The request URL takes the following form:

GET <ROOT>/rest/stonikbyte-project-team-api/1.0/custom-field-value/{userKey}/{fieldId}

Parameters

Parameter	Description
{userKey}	The key of the Jira user for which you want to retrieve the data.
{fieldId}	The id of the user custom field for which you want to retrieve the data.

An example of the request URL with parameters is as follows:

http:/ /MY_Jira_BASE_URL/rest/stonikbyte-project-team-api/1.0/custom-field-value/dorothy.grey/4
In this example the custom field with ID 4 of the user dorothy.grey is retrieved.

A successful response

An HTTP 200 status response indicates a successful request. The following data is returned in JSON format:

JSON

{
  "fieldValueId": 10,
  "fieldId": 4,
  "fieldType": 3,
  "fieldName": "Manager",
  "fieldValue": "john.smith"
}

Data	Description
fieldType	The type of the custom field. Possible values are: 0 - Single Line Text; 1 - Multi Value Picker; 2 - Multi Line Text; 3 - User Picker

Error Response

If the REST call fails, the service returns one of the following HTTP statuses:

HTTP Status Code	Description
401	Returned if the calling user is not authenticated or user does not have enough permissions. Same in case of invalid app license.