Picklists

Use the following endpoint to get picklist values from a picklist of an Embedded customer. View this document (opens new window) to obtain picklist names and parameters for each connector.

Get picklist values

Obtains a list of picklist values for a specified connection in an Embedded customer workspace.

POST /api/managed_users/:id/connections/:connection_id/pick_list

URL Parameters

Name	Type	Description
managed_user_id	string required	Embedded customer ID/external ID. External ID must be prefixed with an E (for example, EA2300) and the resulting ID should be URL encoded.
connection_id	string required	ID of the connection. This can be found in the URL of the app connection or is the result of the List connections endpoint.

Body

Name	Type	Description
pick_list_name	string required	Name of the pick list. Obtain from this document.
pick_list_params	Object optional	Picklist parameters, required in some picklists. For more information view this document.

Sample request

This example curl request obtains a list of Salesforce picklist values from the picklist sobject_fields from the Invoice__c custom object in Salesforce.

curl  -X POST https://www.workato.com/api/managed_users/135703/connections/318457/pick_list \
      -H 'Authorization: Bearer <api_token>' \
      -H 'Content-Type: application/json' \
      -d '{ "pick_list_name": "sobject_fields", "pick_list_params": {"sobject_name": "Invoice__c"}}'

Response

{
    "result": [
        [
            "Record ID",
            "Id"
        ],
        [
            "Owner ID",
            "OwnerId"
        ],
        [
            "Deleted",
            "IsDeleted"
        ],
        [
            "Invoice Name",
            "Name"
        ],
        [
            "Created Date",
            "CreatedDate"
        ],
        [
            "Created By ID",
            "CreatedById"
        ],
        [
            "Last Modified Date",
            "LastModifiedDate"
        ],
        [
            "Last Modified By ID",
            "LastModifiedById"
        ],
        [
            "System Modstamp",
            "SystemModstamp"
        ],
        [
            "Last Viewed Date",
            "LastViewedDate"
        ],
        [
            "Last Referenced Date",
            "LastReferencedDate"
        ],
        [
            "External ID",
            "External_ID__c"
        ],
        [
            "Status",
            "Status__c"
        ],
        [
            "Contact",
            "Contact__c"
        ],
        [
            "Intacct Invoice ID",
            "Intacct_Invoice_ID__c"
        ],
        [
            "Multi-select",
            "Multi_select__c"
        ],
        [
            "Invoiced",
            "Invoiced__c"
        ],
        [
            "Number field",
            "Number_field__c"
        ]
    ]
}