Skip to main content
GET
List email sender rules

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer
default:1
Required range: 0 < x <= 9007199254740991
pageSize
integer
default:50
Required range: 0 < x <= 1000
countOnly
boolean

When true, answers totalCount with an empty data: the rows are never read, so no extend is selected and no transform runs. For a badge or a counter.

Example:

true

extend
any[]

No extend options available for this route.

orderBy
object[]
whereIds
string<uuid>[]

Filter by one or more rule ids.

Maximum array length: 250
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:
whereKind
string[]

Filter by one or more kinds (whitelist / blacklist).

Example:
whereSource
string[]

Filter by one or more sources (manual / auto).

Example:
whereEmail
string

Filter by sender email (contains, case-insensitive).

Maximum string length: 200
Example:

"lobby"

Response

Default Response

data
object[]
required
totalCount
integer
required
Required range: 0 <= x <= 9007199254740991
pagination
object
required