Workspace

Who this key belongs to

Workspace, the key's permissions, plan, this month's usage (sent, queued, remaining, reset date), billing status and any scheduled plan change, member and domain limits, the daily limit of a new workspace, sending domains and senders. Call this first: it is what tells you which address to write from — and, before a send, whether it fits. No particular permission is required.

get/api/v1/me

Request

  • Base URL: https://mailcheer.com
  • URL: https://mailcheer.com/api/v1/me
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key

Response

The state of the workspace.

object'account'
subscribersinteger

Subscribers with status subscribed — the ones a campaign would reach.

Example response

{
  "object": "account",
  "organization": {
    "id": "org_3f9",
    "name": "Your brand",
    "slug": "your-brand"
  },
  "key": {
    "id": "cmu8k1a2b00001n7nkey0prod",
    "name": "Production",
    "scopes": [
      "emails:send",
      "subscribers:read"
    ],
    "mode": "live",
    "language": "en",
    "monthly_limit": {
      "limit": 2400,
      "used": 1830,
      "remaining": 570,
      "resets_at": "2026-10-01T00:00:00.000Z"
    }
  },
  "plan": {
    "id": "pro",
    "name": "Pro",
    "emails_per_month": 150000
  },
  "usage": {
    "period": "2026-09",
    "emails_sent": 1240,
    "emails_in_flight": 60,
    "emails_remaining": 148700,
    "resets_at": "2026-10-01T00:00:00.000Z"
  },
  "billing": {
    "status": "active",
    "subscribed_plan": "pro",
    "current_period_end": "2026-10-18T09:12:40.000Z",
    "cancel_at_period_end": false,
    "trial_ends_at": null,
    "scheduled_change": null,
    "manage_url": "https://mailcheer.com/reglages/facturation"
  },
  "limits": {
    "members": {
      "used": 3,
      "pending_invitations": 1,
      "max": 25
    },
    "sending_domains": {
      "used": 1,
      "max": 25
    },
    "daily": null
  },
  "subscribers": 3182,
  "sending_domains": [
    {
      "domain": "yourdomain.com",
      "verified": true
    }
  ],
  "senders": [
    {
      "id": "snd_71a",
      "from": "hello@yourdomain.com",
      "name": "Your brand",
      "default": true
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.