Retrieving the existing user custom fields
- David Claudia
On this page
Use this method to retrieve the user custom fields that are currently defined in the app along with their attributes.
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
A successful response
An HTTP 200 status response indicates a successful request. The following data is returned in JSON format:
[
{
"id": 2,
"type": 2,
"name": "Bio",
"displayInProjectTabPanel": true,
"displayInUserProfilePanel": true,
"usersMayCreateOptions": false,
"description": ""
},
{
"id": 4,
"type": 3,
"name": "Manager",
"displayInProjectTabPanel": true,
"displayInUserProfilePanel": true,
"usersMayCreateOptions": false,
"description": "The line (direct) manager"
},
{
"id": 3,
"type": 1,
"name": "Skills",
"displayInProjectTabPanel": true,
"displayInUserProfilePanel": true,
"usersMayCreateOptions": false,
"description": ""
},
{
"id": 1,
"type": 0,
"name": "Phone Number",
"displayInProjectTabPanel": true,
"displayInUserProfilePanel": true,
"usersMayCreateOptions": false,
"description": ""
}
]Data | Description |
|---|---|
type | 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. Same in case of invalid app license. |