Skip to main content
POST
List Automation rules

Restrictions

Usage

  • Visible rules: the caller’s own personal rules plus rules of teams the caller belongs to. Account owners and admins see only the teams they belong to, never other people’s personal rules.
  • scope=personal returns only the caller’s personal rules; scope=team only rules of the caller’s teams. team_ids narrows the result further and never expands access.
  • Results are sorted by updated_at descending. Each item carries last_run (the most recent run) when the rule has ever run.
  • can_edit on each item tells whether the caller can manage (get, update, delete, run) that rule.

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

List Automation rules visible to the caller: their own personal rules plus rules of teams they belong to. Account owners and admins are bounded the same way.

p
integer
default:1

Page number, 1-based.

limit
integer
default:20

Page size. Values below 1 fall back to 20; values above 200 are capped at 200.

Required range: x <= 200
scope
enum<string>

Scope filter: all (default) your personal rules plus rules of your teams; personal only your personal rules; team only rules of your teams.

Available options:
all,
personal,
team
team_ids
integer<int64>[]

Filter to these team IDs; this narrows results and does not expand access.

include_person
boolean | null

Legacy switch. Only read when scope is empty: false behaves like scope=team; otherwise ignored.

enabled
boolean | null

Filter by enabled state: true returns only enabled rules, false only disabled; omit or pass null for no filter.

keyword
string

Returns rules whose name contains this text. At most 64 characters.

Maximum string length: 64

Response

Success

Standard response envelope used by every Flashduty public API. On success data contains the endpoint-specific payload and error is absent. On failure error is present and data is absent. request_id is always present and is also mirrored in the Flashcat-Request-Id response header.

request_id
string
required

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

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

error
object

Error payload inside the response envelope. Present only on non-2xx responses.

data
object

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