Skip to main content

Get field options

POST 
/field/options

Function Overview

  • Get option data for specified fields, supporting multiple field types (options, members, projects, etc.).

  • Supports keyword search, UUID filtering, field selection and other functions.

  • Different field types return different field structures, such as option types containing color information, member types containing avatars, etc.

Common Usage

  • Get priority options: Returns option list containing uuid, value, background_color, color
  • Get member list: Returns user information containing uuid, name, avatar
  • Get project list: Returns project information containing uuid, name, status

Example

{
  "field_uuid": "field012",
  "include_fields": ["uuid", "value", "background_color", "color"],
  "keyword": "",
  "limit": 100
}

Request​

Query Parameters

    teamID stringrequired

    The team ID

Body

    field_uuid stringrequired

    Field UUID

    uuids string[]

    Specify list of option UUIDs to return

    include_fields string[]

    Specify list of fields to return

    keyword string

    Keyword search

    limit integer

    Default value: 20

    Return quantity limit

    offset integer

    Default value: 0

    Offset

Responses​

Request successful

Response Example

[
  {
    "uuid": "TcCM4kwC",
    "value": "Highest",
    "background_color": "#e63422",
    "color": "#FFFFFF"
  },
  {
    "uuid": "QA5U45FD",
    "value": "High",
    "background_color": "#ffe9e2",
    "color": "#ff6a39"
  },
  {
    "uuid": "BcDf5gHi",
    "value": "Medium",
    "background_color": "#ffd700",
    "color": "#000000"
  }
]

Field Description

  • uuid: Unique identifier of the option
  • value: Display name of the option
  • background_color: Background color of the option (hexadecimal)
  • color: Text color of the option (hexadecimal)

Note: Different field types may return different field structures. The above example is for option-type fields.

Schema

  • Array [

    • property name* any

    Field option object, field structure varies by field type

  • ]

Loading...