Skip to main content
POST
List fields

Restrictions

Usage

  • All non-deleted fields are returned in one response, without pagination or total. Sorted by orderby (default created_at), newest first unless asc is true.
  • query is a case-insensitive regular expression on field_name; an invalid expression is matched as literal text.

Authorizations

app_key
string
query
required

APP Key created in the Flashduty console under My → APP Key. Send it as the app_key query parameter or in the Fd-App-Key request header. Its effective access is the intersection of the key's permission scope and the creator's current role permissions. Keep it secret.

Body

application/json
orderby
enum<string>

Sort key. Defaults to created_at 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 matched against field_name only. An invalid regex is auto-escaped to a 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

Operation-specific payload, documented in each operation's 200 response. Operations without a payload return {} or omit data entirely.