Skip to navigation
API ReferenceForwarding

Get Forwarding

Get the forwarding the organization sets. Pods and inboxes that set no forwarding of their own use this list. Needs an organization-scoped API key.

CLI:

agentmail forwarding get

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

This endpoint returns an object.
destinationslist of strings or null

Addresses this level forwards to. null when the level sets nothing and uses the forwarding of the level above. An empty list means forwarding is turned off at this level, even when a level above forwards.

unverifiedlist of strings

Addresses in destinations that receive nothing yet because they are not verified, or because the address now reaches a different AgentMail inbox than the one it was verified for. Verify them with Start Verification and Confirm Verification. Empty when destinations is null.

Errors

403
Forwarding Forbidden Error