Get Forwarding Rule

GET

https://api.inboxkit.com/v1/api/mailboxes/forwarding/rules/{uid}

Maintainer:Not configured

Gets one advanced forwarding rule, with its conditions, mailboxes and status.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Header Params

Responses

🟢200Success Response

application/json

Bodyapplication/json

🟠404Rule Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.inboxkit.com/v1/api/mailboxes/forwarding/rules/' \
--header 'X-Workspace-Id;' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "error": false,
    "message": "Forwarding rule retrieved successfully",
    "rule": {
        "uid": "9b2f7c1e-0d4a-4b8e-9a51-3f0c6d2e8a17",
        "platform": "GOOGLE",
        "scope": "google",
        "match": "all",
        "conditions": [
            {
                "location": "subject",
                "header_name": "X-Autoreply",
                "match": "regex",
                "value": "out of office"
            }
        ],
        "forwarding_email": "[email protected]",
        "mailboxes": [
            {
                "uid": "mb-123e4567-e89b-12d3-a456-426614174000",
                "email": "[email protected]"
            }
        ],
        "status": "pending",
        "last_error": "string",
        "applied_at": "2019-08-24T14:15:22.123Z",
        "created_at": "2026-11-05T10:30:00.000Z",
        "updated_at": "2026-11-05T10:30:00.000Z"
    }
}

Modified at 2026-11-05 15:01:16

List Forwarding Rules

Update Forwarding Rule