Overview

Account metadata and usage are available via standard API-key endpoints:

GET /v1/account
GET /v1/account/usage

Integration host: https://developers-api.chatmaid.net.

Get Account

GET /v1/account

Get account profile for the API key owner.

Get Account Auth and Status Codes

Item	Value
Recommended scope	`account:read`
Also accepted scopes	`messages:read, messages:send, messages:write`
Success code	`200`
Error codes	`401, 403, 429`

curl -X GET https://developers-api.chatmaid.net/v1/account \
  -H "Authorization: Bearer sk_test_xxx"

const response = await fetch("https://developers-api.chatmaid.net/v1/account", {
  headers: { Authorization: "Bearer " + process.env.CHATMAID_API_KEY },
});

const payload = await response.json();

import os
import requests

response = requests.get(
    "https://developers-api.chatmaid.net/v1/account",
    headers={"Authorization": f"Bearer {os.environ['CHATMAID_API_KEY']}"},
)

payload = response.json()

{
  "success": true,
  "data": {
    "accountId": "acc_abc123def456",
    "name": "Acme Inc",
    "email": "developer@acme.com",
    "subscriptionStatus": "active",
    "stats": {
      "apiKeys": 2,
      "phoneNumbers": 1,
      "messages": 328
    }
  }
}

Usage

GET /v1/account/usage

Get account usage metrics for day, week, or month.

Usage Request Contract

Parameter	In	Type	Required	Rules
`period`	Query	`string`	No	day \| week \| month, default month
Required scope	-	`account:read`	No	messages:* scopes are also accepted.
Status codes	-	`200 \| 401 \| 403 \| 429`	Yes	Typical usage endpoint responses.

curl -X GET "https://developers-api.chatmaid.net/v1/account/usage?period=month" \
  -H "Authorization: Bearer sk_test_xxx"

const response = await fetch("https://developers-api.chatmaid.net/v1/account/usage?period=month", {
  headers: { Authorization: "Bearer " + process.env.CHATMAID_API_KEY },
});

const payload = await response.json();

import os
import requests

response = requests.get(
    "https://developers-api.chatmaid.net/v1/account/usage",
    headers={"Authorization": f"Bearer {os.environ['CHATMAID_API_KEY']}"},
    params={"period": "month"},
)

payload = response.json()

{
  "success": true,
  "data": {
    "period": "month",
    "startDate": "2026-01-07T14:20:00.000Z",
    "endDate": "2026-02-06T14:20:00.000Z",
    "messages": {
      "total": 328,
      "pending": 0,
      "sent": 314,
      "failed": 14
    },
    "apiRequests": {
      "total": 1242,
      "successful": 1221,
      "failed": 21
    }
  }
}

Account