SMAO API Documentation
Distributor API v1Usage

Get usage for a single organization

GET
/organizations/{organizationId}/usage

Authorization

DistributorApiKey
AuthorizationBearer <token>

Long-lived distributor API key scoped to a channel partner on the shared smao instance.

In: header

Path Parameters

organizationId*string

MongoDB ObjectId of the organization.

Match^[a-fA-F0-9]{24}$

Query Parameters

from*string

Start date in YYYY-MM-DD format, inclusive.

Formatdate
to*string

End date in YYYY-MM-DD format, inclusive.

Formatdate

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/organizations/665abc123def456789012345/usage?from=2019-08-24&to=2019-08-24"
{  "status": "success",  "organization": {    "id": "69c175970f3e28310926a1aa",    "name": "string",    "externalCustomerId": "string"  },  "period": {    "from": "2019-08-24T14:15:22Z",    "to": "2019-08-24T14:15:22Z"  },  "usage": {    "calls": {      "count": 0,      "minutes": 0    },    "forwards": {      "count": 0,      "minutes": 0    },    "assistants": 0,    "sms": {      "count": 0,      "segments": 0    },    "whatsapp": 0  }}

Delete organization DELETE

Permanently delete a partner-managed organization and all associated data including subscriptions, invitations, assistants, calls, contacts, knowledge, and S3 storage. This action is irreversible.

Get aggregated usage for a single partner's organizations GET

Returns aggregated usage across all customer organizations that belong to the specified partner (MSP), plus a per-organization breakdown.