Skip to navigation
Atomicwork Public APIForms

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_typelist of enumsOptional

Optional request type(s) to scope options by. Comma-separated (e.g. request_type=REQUEST,INCIDENT). For status this returns the union of statuses mapped to any of the given types (de-duplicated). Omitting it returns options for all types (backward compatible). A single value behaves exactly as before.

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)

user_typeenumOptional

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.

Allowed values:
template_idlongOptional

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

Successful response