SMAO API Documentation
Distributor API v1Organizations

List organizations

GET
/organizations

Returns a paginated list of customer organizations across all your partners. Use the optional partnerId query parameter to filter by a specific MSP. Use externalCustomerId to look up a customer by your own identifier.

Authorization

DistributorApiKey
AuthorizationBearer <token>

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

In: header

Query Parameters

page?integer

1-based page number.

Range1 <= value
Default1
limit?integer

Page size.

Range1 <= value <= 100
Default50
externalCustomerId?string

Exact-match filter for the distributor customer identifier.

Length1 <= length <= 255
partnerId?string

Filter results to a specific partner (MSP). Omit to include all organizations.

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

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/organizations"
{  "status": "success",  "page": 1,  "limit": 1,  "total": 0,  "organizations": [    {      "id": "69c175970f3e28310926a1aa",      "name": "string",      "industry": "string",      "timezone": "string",      "channelPartner": "acme",      "externalCustomerId": "string",      "externalContractId": "string",      "partnerId": "665abc123def456789012345",      "ownerEmail": "user@example.com",      "createdAt": "2019-08-24T14:15:22Z",      "plan": {        "id": "6967b1c7138bed3e7f6bf7e6",        "slug": "string",        "name": "string",        "commitment": "none",        "currency": "string",        "baseFee": 0      }    }  ]}

Delete partner DELETE

Deletes a partner only when it has no linked customer organizations and no internal MSP organization. Partners created through v1 normally have an internal organization, so this operation returns `409 PARTNER_HAS_ORGANIZATIONS` until that organization has been removed outside this endpoint. There is no cascade delete.

Create organization and initial owner invitation POST

Creates a new customer organization under the specified partner (MSP), creates its owner invitation record, and attempts to send the invitation email.