Skip to main content

Get property field options

GET 
/api/v4/properties/groups/:group_name/:object_type/fields/:field_id/options

Get one page of a property field's options in creation order, including options inherited from a linked template. Use it to read a field with more than 1000 options, which is returned without attrs.options.

Keep requesting pages while has_more is true, passing back next_cursor_create_at and next_cursor_id as cursor_create_at and cursor_id. A short or empty page doesn't mean the listing has ended.

Minimum server version: 12.0

Permissions​

The same as reading the field: any authenticated user for a system-level field, view_team on the team for a team-level field, and read_channel on the channel for a channel-level field.

Request​

Responses​

Property field options retrieval successful