Companies API

Create, read, update, suspend, and delete companies managed by your reseller account.

Endpoints Overview

MethodEndpointDescription
GET/v1/reseller/companiesList companies.
POST/v1/reseller/companiesCreate a company.
GET/v1/reseller/companies/{id}Get company details.
PUT/v1/reseller/companies/{id}Update company details.
DELETE/v1/reseller/companies/{id}Delete a company.

List Companies

Returns a paginated list of companies owned by the authenticated reseller.

ParameterTypeDescription
pageintegerPage number.
per_pageintegerItems per page, capped at 100.
searchstringFilter by company name or contact email.
statusstringFilter by company status.

Create or Update Company

FieldTypeDescription
namestringCompany display name.
contact_emailstringPrimary contact email address.
seat_limitintegerMaximum seats available to the company.
seat_limit_typestringhard blocks overages; soft allows overages.
statusstringCompany status such as active or suspended.

Deletion Rule

A company can only be deleted when no active users remain. Otherwise the API returns HAS_ACTIVE_USERS.

Response Example

{
  "data": {
    "id": 1,
    "name": "Acme Corporation",
    "contact_email": "admin{'@'}example.com",
    "status": "active",
    "seat_limit": 100,
    "seat_limit_type": "hard",
    "seats_used": 45
  }
}