List rules

Returns a list of all rules for your application.

get/v3/rules

Query parameters

limitinteger

The maximum number of objects to return. See Pagination for more information.

page_tokenstring

A token to fetch the next page of results. Use the next_cursor value from the previous response.

Response

request_idstring

ID of the request.

next_cursorstring

A token to use for paginating through results. If present, pass this value as page_token in the next request.

Example response

{
  "request_id": "5fa64c92-e840-4357-86b9-2aa364d35b88",
  "data": [
    {
      "id": "c1d2e3f4-5678-4abc-9def-0123456789ab",
      "name": "Block spam domains",
      "description": "Rejects messages from known spam domains at the SMTP level.",
      "priority": 1,
      "enabled": true,
      "trigger": "inbound",
      "match": {
        "operator": "any",
        "conditions": [
          {
            "field": "from.domain",
            "operator": "is"
          }
        ]
      },
      "actions": [
        {
          "type": "block",
          "value": "Receipts"
        }
      ],
      "application_id": "ad410018-d306-43f9-8361-fa5d7b2172e0",
      "organization_id": "org-abc123",
      "created_at": 1742932766,
      "updated_at": 1742932766
    }
  ],
  "next_cursor": "eyJhbGciOiJIUzI1NiJ9"
}

Changes

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