AGagentmail-to
organizations

Get Organization

Changed on

Returns the organization for the authenticated API key (usage limits, counts, and billing metadata).

CLI:

agentmail organizations get
get/v0/organizations

Request

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

Response

Response with status 200

organization_idstring required

ID of organization.

inbox_countinteger required

Current number of inboxes.

domain_countinteger required

Current number of domains.

inbox_limitinteger

Maximum number of inboxes allowed.

domain_limitinteger

Maximum number of domains allowed.

billing_idstring

Provider-agnostic billing customer ID.

billing_typestring

Billing provider type (e.g. "stripe").

billing_subscription_idstring

Active billing subscription ID.

authentication_idstring

Provider-agnostic authentication ID.

authentication_typestring

Authentication provider type.

suspended_atstring date-time

Time at which the organization was suspended. Absent when it is not suspended. A suspended organization cannot send, but it still receives mail, its webhooks and WebSocket events still fire, and API reads keep working. See account_suspended.

suspended_reasonstring

Why the organization is suspended, in a short machine-readable form such as message.bounced or message.complained. Absent when it is not suspended. Email support@agentmail.cc to resolve a suspension.

updated_atstring date-time required

Time at which organization was last updated.

created_atstring date-time required

Time at which organization was created.

Changes

  • 3f5c7830c952Revision changes
    • info

      the endpoint scheme security Bearer was added to the API

    • info

      the endpoint scheme security BearerAuth was removed from the API

    • info

      api tag organizations added

    • info

      api tag Organizations removed

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 27965096e618Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status