Chatmaid Developers

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/accountAuth: API key

Get account profile for the API key owner.

Response

data.accountId
data.name
data.subscriptionStatus
data.stats.apiKeys/phoneNumbers/messages

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`

Get Account

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

Expected 200 Response

{
  "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/usageAuth: API key

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

Request

Query: period? (day|week|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.

Get Usage

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

Expected 200 Response

{
  "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,
      "delivered": 306,
      "read": 298,
      "failed": 14
    },
    "apiRequests": {
      "total": 1242,
      "successful": 1221,
      "failed": 21
    }
  }
}