Get list of options for the field identified by reference_key

GET https://{tenant}.atomicwork.com/api/v1/forms/{entity_type}/{reference_key}/entities

Authorization

X-Api-Keyheaderstringrequired

Headers

X-Workspace-Idheaderstring

Path Parameters

entity_typepathenum (string)required

reference_keypathstringrequired

The reference key of a entity reference field

Query Parameters

workspace_idqueryinteger

The workspace id

request_typequeryenum (string)

request_idquerystring

The request display id

entity_idqueryinteger

The service item id in case entity_type is SERVICE_ITEM

parent_option_idqueryinteger

The parent option ID to query for child options

search_keyquerystring

selected_options_idsqueryarray of integer

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

selected_option_idsqueryarray of integer

is_flattened_nested_field_requiredqueryboolean

pagequeryintegerrequired

per_pagequeryinteger

viewqueryenum (string)

is_workspace_memberqueryboolean

subviewqueryenum (string)

should_have_system_userqueryboolean

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

user_typequeryenum (string)

Narrows the assignee/agent picker to a single user category. EMPLOYEE returns human users only, AI_EMPLOYEE returns AI coworkers only. These are the only two values used by the picker tabs. When omitted, humans and AI coworkers are returned together (current behavior). Any other enum value (e.g. EXTERNAL) is filtered as-is and yields no assignable users, since external users are not valid assignees. Applied only to the user-flavoured assignee resolution path; ignored for every other entity type.

template_idqueryinteger

Change template ID. When entity_type=CHANGE and reference_key=requester, filters the response to workspace members allowed by the template's user_segments (workspace agents always included). Ignored otherwise.

Response

200application/json

Successful response