Retrieving the values of all custom fields for a user

On this page

Use this method to retrieve the value of all the custom fields for a specified Jira user. Only the fields that have a value set are returned.

IMPORTANT: 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}

Parameters

Parameter	Description
{userKey}	The key of the Jira user 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
In this example the custom field values of the user dorothy.grey are retrieved.

A successful response

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

JSON

{
  "userKey": "dorothy.grey",
  "customFieldValues": [
    {
      "fieldValueId": 2,
      "fieldId": 2,
      "fieldType": 2,
      "fieldName": "Bio",
      "fieldValue": "Dorothy is an experienced programmer with strong skills in Web design..."
    },
    {
      "fieldValueId": 10,
      "fieldId": 4,
      "fieldType": 3,
      "fieldName": "Manager",
      "fieldValue": "john.smith"
    },
    {
      "fieldId": 3,
      "fieldType": 1,
      "fieldName": "Skills",
      "customFieldValueOptions": [
        {
          "valueAssociationId": 20,
          "inputOptionId": 2,
          "inputOptionName": "GUI Design"
        },
        {
          "valueAssociationId": 21,
          "inputOptionId": 3,
          "inputOptionName": "Programming"
        }
      ]
    },
    {
      "fieldValueId": 1,
      "fieldId": 1,
      "fieldType": 0,
      "fieldName": "Phone Number",
      "fieldValue": "206 1234 45678"
    }
  ]
}

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
fieldId	The id of the user custom field.

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.