Sign in
Contact Rules

List Org Mail Contact Rules

get/api/v1/mail/contact-rules

Query parameters

agent_identity_idstring uuid nullable

Narrow to a single agent identity. Omit to list across every identity in the org.

Narrow to a single agent identity. Omit to list across every identity in the org.

action'allow' | 'block'

Filter by allow or block.

match_type'exact_email' | 'domain'

Filter by exact_email or domain.

limitinteger

Max rules to return.

Max rules to return.

offsetinteger

Number of rules to skip.

Number of rules to skip.

Response

Successful Response

idstring uuid required
agent_identity_idstring uuid required
action'allow' | 'block' required
match_type'exact_email' | 'domain' required
match_targetstring required
status'active' | 'paused' | 'deleted' required
created_atstring date-time required
updated_atstring date-time required

Changes

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