List a connection's keyword rules

GET

/v1/integrations/{type}/connections/{id}/keywords/{list}

Returns the per-connection keyword rules for the chosen {list} (blacklist = always-remove, whitelist = never-remove). The universal settings object on GET /v1/integrations/{type} only reports the COUNTS (blacklist_count/whitelist_count); this endpoint returns the rules themselves. Each rule carries a stable id, the keyword, its match strategy (exact/contains), and the applies_to segment toggles (localpart/domain/email). Always paginated with the universal cursor envelope (default per_page = 50, max 100); the cursor is opaque — clients MUST NOT parse it. Unknown type or list, or a connection id that does not exist or belongs to another org, → 404 not_found.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Query Params

Responses

🟢200

application/json

Paginated keyword rules

Bodyapplication/json

🟠400

🟠401

🟠403

🟠404

🟠429

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.mailfloss.com/v1/integrations//connections//keywords/?per_page=&cursor=' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Success

{
    "data": [
        {
            "id": "kw_7f8e9d0c1b2a3f4e",
            "keyword": "noreply",
            "match": "exact",
            "applies_to": {
                "localpart": true,
                "domain": false,
                "email": false
            }
        },
        {
            "id": "kw_6e7d8c9b0a1f2e3d",
            "keyword": "mailinator",
            "match": "contains",
            "applies_to": {
                "localpart": false,
                "domain": true,
                "email": false
            }
        }
    ],
    "pagination": {
        "next_cursor": null,
        "has_more": false
    }
}

Modified at 2026-10-20 13:54:45

Test a connection's credentials

Add keyword rules