Sign in
Rule

List rules

List all rules objects.

get/api/v1/rules

Query parameters

page_sizeinteger

Number of results per page

cursorstring

A value used for cursor-based pagination. Obtain this value from the next or previous URLs in a paginated response. Do not construct cursor values manually.

idinteger[]

Object ID(s) filter

queueinteger[]

List rules by queue ids.

enabledboolean

List only enabled/disabled rules.

linkedboolean

List only linked/unlinked rules (linked rules have more than one queue connected).

actionsstring[]

Comma separated list of action types (e.g. show_message,change_queue).

namestring

Object name filter

organizationinteger[]

Organization ID(s) filter

ordering'id' | '-id' | 'name' | '-name' | 'organization' | '-organization'

Result ordering.

Response

OK

resultsRule[] required— unresolved $ref

Changes

No recorded changes to this endpoint across all 1 revision of this API.