Read every setting

GET /api/v1/settings Every setting of the organization in one read: who signs its emails, how sign-up behaves, and whether it can send at all. Deliberately aggregated — an agent that needs six calls to know the state of an account will make five and get it wrong.

Authorization

Role in the organizationThis endpoint
OWNERAllowed
ADMINAllowed
MEMBERAllowed
A key carries the role its creator holds in this organization — never a role on AgentsMail itself. See API keys.

Example

bash
curl -H "x-api-key: $AGENTMAIL_API_KEY" \
  "https://www.agentsmail.io/api/v1/settings"

Response

  • 200 OK — the call succeeded.
  • 401 Unauthorized — missing or invalid key, or its owner left the organization.
  • 429 Too Many Requests — over 120 requests in a minute for this key.

Response fields

effectiveSender is the one to check, not senderEmail. It is the address the next campaign will really leave under, including the fallback used while no domain is verified.
FieldTypeDescription
successbooleanIndicates if the operation was successful
data.sending.senderEmailstring \null
data.sending.senderNamestring \null
data.sending.postalAddressstring \null
data.sending.effectiveSenderstring \null
data.optin.requiredbooleanWhether a new contact must confirm before being subscribed
data.optin.subjectstringSubject of the confirmation email — the default when never customized
data.optin.contentstringIts HTML, same rule
data.optin.customizedbooleanfalse means the two fields above are the product defaults
data.readinessobjectThe same object GET /api/v1/me returns under sending: ready, blockers, setup

Example response

json
{
  "success": true,
  "data": {
    "sending": {
      "senderEmail": "hello@mail.example.com",
      "senderName": "Example",
      "postalAddress": "12 rue des Lilas, 59000 Lille",
      "effectiveSender": "Example <hello@mail.example.com>"
    },
    "optin": {"required": true, "subject": "Confirm your subscription", "content": "<html>…</html>", "customized": false},
    "readiness": {"ready": true, "blockers": [], "setup": {"status": "verified", "provisioning": "provisioned"}}
  }
}

Related