Skip to main content
POST
/
field
/
list
List fields
curl --request POST \
  --url 'https://api.flashcat.cloud/field/list?app_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "orderby": "updated_at",
  "asc": false,
  "query": "severity"
}
'
{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "items": [
      {
        "account_id": 80001,
        "field_id": "66e9d3a4f7c2b04a1c8a91b3",
        "field_name": "severity_class",
        "display_name": "Severity Class",
        "description": "Business severity tier.",
        "field_type": "single_select",
        "value_type": "string",
        "options": [
          "Critical",
          "High",
          "Medium",
          "Low"
        ],
        "default_value": "Medium",
        "status": "enabled",
        "creator_id": 80011,
        "updated_by": 80011,
        "created_at": 1710000000,
        "updated_at": 1710000000
      }
    ]
  }
}

​
Restrictions

AspectValue
Rate limits1,000 requests/minute; 50 requests/second per account
PermissionsIncidents Read (on-call) or Incidents Manage (on-call)

​
Usage

  • All non-deleted fields are returned in a single response — there is no pagination and no total counter.
  • query matches against field_name and display_name; invalid regular expressions are auto-escaped to a literal substring match.

Authorizations

​
app_key
string
query
required

App key issued from the Flashduty console under Account → APP Keys. Required on every public API call. Keep it secret — it grants the same access as the owning account.

Body

application/json
​
orderby
enum<string>

Sort key. Defaults to backend ordering when omitted.

Available options:
created_at,
updated_at
​
asc
boolean

Sort ascending when true; descending otherwise.

​
creator_id
integer<int64> | null

Filter by creator member ID. Omit or send null to skip.

​
query
string

Regex filter against field_name and display_name. Invalid regex is auto-escaped to literal substring match.

Response

Success

Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.

​
request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

​
data
object
required

Endpoint-specific payload. See each operation's 200 response schema.