getFormFieldEntities

View as Markdown

Get entity options for a form field.

Returns entity options for a specific form field (e.g., status, priority, assignee). Use this to populate dropdown/select fields that reference entities. WHEN TO USE THIS ENDPOINT: Use this endpoint when a form field has type: "ENTITY_REFERENCE".

Parameters

NameTypeRequiredDescription
entityTypeEntityTypeYesThe entity type for the form field
referenceKeystringYesThe reference key of the dropdown field
workspace_idintegerNoThe workspace ID
request_typeRequestTypeDTONoThe request type (REQUEST, INCIDENT, SERVICE_REQUEST, PROBLEM)
request_idstringNoThe request display ID
entity_idintegerNoThe entity ID (e.g., service item ID)
parent_option_idintegerNoParent option ID for nested dropdowns
search_keystringNoSearch key to filter options
is_flattened_nested_field_requiredbooleanNoWhether to return flattened nested field options Default: False.
is_workspace_memberbooleanNoFilter by workspace membership
pageintegerNoDefault: 1.
per_pageintegerNoDefault: 25.