Picklist Values, Get

Get the values for a picklist.

Resource

1/ui-api/object-info/{objectApiName}/picklist-values/{recordTypeId}/{fieldApiName}

Available version

39.0

HTTP methods

GET

Response body for GET

Picklist Values

Example

When you make a request to /ui-api/record-ui/{recordIds} or /ui-api/object-info/{objectApiName}, if the response includes a picklist field, it also includes a picklistValuesUrls property. That property contains a Picklist Values resource with the {objectApiName}, {recordTypeId}, and {fieldApiName} filled in, as in this example:

1GET /services/data/v40.0/ui-api/object-info/Account/picklist-values/012000000000000AAA/Type/
2
3{
4  "controllerValues" : { },
5  "defaultValue" : null,
6  "url" : "/services/data/v39.0/ui-api/object-info/Account/picklist-values/012000000000000AAA/Type",
7  "values" : [ {
8    "attributes" : null,
9    "label" : "Analyst",
10    "picklistAttributesValueType" : "Standard",
11    "validFor" : [ ],
12    "value" : "Analyst"
13  }, {
14    "attributes" : null,
15    "label" : "Competitor",
16    "picklistAttributesValueType" : "Standard",
17    "validFor" : [ ],
18    "value" : "Competitor"
19  }, 
20
21  ... some picklist values removed for space ...
22
23  {
24    "attributes" : null,
25    "label" : "Other",
26    "picklistAttributesValueType" : "Standard",
27    "validFor" : [ ],
28    "value" : "Other"
29  } ]
30}

User Interface API Developer Guide

Picklist Values, Get

See Also: