Skip to main content
POST
Get field detail

Restrictions

Usage

  • An unknown field_id returns InvalidParameter. A deleted field is returned with status = deleted until the background cleanup started by /field/delete finishes; after that its ID is unknown.
  • The shape of options and default_value depends on field_type; see the FieldItem schema.

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
field_id
string
required

Field ID — 24-character hex ObjectID.

Pattern: ^[a-f0-9]{24}$

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

Incident custom field configuration.