Skip to main content
GET
curl

Authorizations

x-api-key
string
header
required

Your application's API key, from Developers -> API keys in the Business Console. The primary key has full access. A named key can be scoped: none, read or write per resource, limited to some workflows or to approved sessions, to a list of IP addresses, and to an expiry date. 401 means the key is missing, wrong, revoked or expired; 403 means the key has no access to this resource or action, or the request came from an address outside its IP list; 404 on a session route means the session is outside the key's workflows or statuses. A key without media access receives image, video and PDF URLs as null, and a key without sessions write receives session links and tokens as null. See https://docs.didit.me/console/api-keys.

Query Parameters

source
enum<string>

PRESET or CUSTOM

Available options:
PRESET,
CUSTOM
category
string

Filter by rule category

mode
enum<string>

ACTIVE, DISABLED or TEST

Available options:
ACTIVE,
DISABLED,
TEST
bundle
string

Filter presets by bundle

Case-insensitive match against title and description

ordering
string

Comma-separated ordering fields, default source,-run_count

limit
integer

Page size

offset
integer

Page offset

Response

200 - application/json

Paginated rules.

count
integer
next
string | null
previous
string | null
results
object[]