Skip to navigation
API ReferencePodsForwarding

Get Forwarding

Get the forwarding this pod sets. Its inboxes that set no forwarding of their own use this list. When the pod sets nothing, destinations is null and the pod uses the organization’s forwarding.

CLI:

agentmail pods forwarding get --pod-id <pod_id>

Authentication

AuthorizationBearer

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

Path parameters

pod_idstringRequired
ID of pod.

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
404
Not Found Error