Get list of options for the field identified by reference_key

View as Markdown

Authentication

X-Api-Keystring
API Key authentication via header

Path parameters

entity_typeenumRequired
reference_keystringRequired1-255 characters
The reference key of a entity reference field

Headers

X-Workspace-IdstringOptional

Query parameters

workspace_idlongOptional
The workspace id
request_typeenumOptional
request_idstringOptional
The request display id
entity_idlongOptional

The service item id in case entity_type is SERVICE_ITEM

parent_option_idlongOptional
The parent option ID to query for child options
search_keystringOptional>=1 character
selected_options_idslist of longsOptional

Deprecated, DO NOT USE. This was a typo. Use selected_option_ids instead.

selected_option_idslist of longsOptional
is_flattened_nested_field_requiredbooleanOptionalDefaults to false
pageintegerRequired1-100Defaults to 1
per_pageintegerOptional1-1000Defaults to 25
viewenumOptional
is_workspace_memberbooleanOptional
subviewenumOptional
Allowed values:
should_have_system_userbooleanOptionalDefaults to false

Include system users and bots in the response (SYSTEM and ATOMIC_BOT types)

Response

Successful response