Get Forwarding Capabilities

GET

https://api.inboxkit.com/v1/api/mailboxes/forwarding/capabilities

Maintainer:Not configured

Shows what you can filter on for Google and Microsoft mailboxes, and the limits. Check it before setting up advanced forwarding.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Header Params

Responses

🟢200Success Response

application/json

Bodyapplication/json

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

{
    "error": false,
    "message": "Forwarding capabilities retrieved successfully",
    "data": {
        "modes": [
            "simple",
            "advanced"
        ],
        "matches": [
            "all",
            "any"
        ],
        "limits": {
            "max_rules_per_workspace": 100,
            "max_mailboxes_per_request": 500
        },
        "platforms": {
            "GOOGLE": {
                "platforms": [
                    "GOOGLE"
                ],
                "locations": {
                    "property1": [
                        "regex"
                    ],
                    "property2": [
                        "regex"
                    ]
                },
                "notes": {
                    "property1": "string",
                    "property2": "string"
                },
                "limits": {
                    "max_conditions": 0,
                    "max_value_length": 0,
                    "max_regex_length": 0,
                    "max_rules_per_domain": 0
                }
            },
            "MICROSOFT": {
                "platforms": [
                    "GOOGLE"
                ],
                "locations": {
                    "property1": [
                        "regex"
                    ],
                    "property2": [
                        "regex"
                    ]
                },
                "notes": {
                    "property1": "string",
                    "property2": "string"
                },
                "limits": {
                    "max_conditions": 0,
                    "max_value_length": 0,
                    "max_pattern_length": 0,
                    "max_mailboxes_per_rule": 0,
                    "max_rules_per_tenant": 0
                }
            }
        }
    }
}

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

List Forwarding Jobs

Set Up Advanced Forwarding