Skip to main content
POST
List Automation rules

Restrictions

Usage

  • all returns your personal rules plus team rules you can access.
  • Account admins see all team rules in list results, but not other users’ personal rules.
  • team_ids narrows the visible set and never expands access.

Authorizations

app_key
string
query
required

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

Body

application/json

List Automation rules visible to the caller. all includes the caller's personal rules plus accessible team rules; account admins do not see other users' personal rules in list results.

p
integer
default:1

Page number, 1-based.

limit
integer
default:20

Page size.

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

Scope filter: all (own personal + accessible team rules), personal, or team; default all.

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

Compatibility field; when scope is empty and this is false, behaves like team scope.

enabled
boolean | null

Filter by enabled status.

keyword
string

Filter by name keyword.

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

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