customObjectGetFieldOptions

View as Markdown

Get dropdown options for a custom object field.

Returns the valid dropdown options for a DROPDOWN or MULTI_DROPDOWN field on a custom object type. When to Use: After calling getObjectTypeFormFields(), for any field where type is DROPDOWN, MULTI_DROPDOWN, or NESTED_DROPDOWN, call this endpoint to get the list of valid values.

Parameters

NameTypeRequiredDescription
referenceKeystringYesThe referenceKey of the dropdown field (from getObjectTypeFormFields response)
entity_idintegerYesThe object type ID (required to scope options to the correct type)
parent_option_idintegerNoParent option ID for nested dropdowns — get child options under this parent
search_keystringNoSearch/filter options by label text
pageintegerNoDefault: 1.
page_sizeintegerNoDefault: 25.