AGagentmail-to
auth

Who Am I

Changed on

Returns the identity and scope of the authenticated credential. Useful when a client holds a pod-scoped or inbox-scoped API key and needs to discover the parent organization, pod, or inbox without prior knowledge.

CLI:

agentmail auth me
get/v0/auth/me

Request

  • Base URL
    https://api.agentmail.to
  • URL
    https://api.agentmail.to/v0/auth/me
  • Auth
    HTTP bearer

Response

Response with status 200

scope_type'organization' | 'pod' | 'inbox' required

The scope tier the authenticated credential is bound to.

scope_idstring required

ID of the most specific scope the credential is bound to. Equals inbox_id when scope_type is inbox, pod_id when pod, organization_id when organization.

organization_idstring required

ID of organization.

pod_idstring

ID of the pod the credential is scoped to. Present when scope_type is pod or inbox.

inbox_idstring

ID of the inbox the credential is scoped to. Present when scope_type is inbox.

api_key_idstring

ID of the API key used to authenticate. Absent for JWT and proxy credentials.

Changes