Skip to main content
POST
List fields

Restrictions

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.