Skip to main content

List Enterprises

Endpoint

GET /api/v1/admin/enterprises

Required Role

  • Super Admin

Query Parameters

ParameterTypeDescription
statusstringFilter by status: active, inactive
pageintegerPage number
page_sizeintegerItems per page

Response

{
  "data": [
    {
      "id": "ent-uuid-001",
      "name": "ACME Corporation",
      "country": "US",
      "registration_number": "REG-12345",
      "status": "active",
      "subscription_tier": "enterprise",
      "mrr_cents": 199900,
      "created_at": "2025-06-01T00:00:00Z",
      "user_count": 25,
      "bra_count": 15
    }
  ],
  "pagination": { ... }
}

Create Enterprise

Endpoint

POST /api/v1/admin/enterprises

Required Role

  • Super Admin

Request Body

{
  "name": "New Corporation",
  "country": "BR",
  "registration_number": "12.345.678/0001-90"
}

Response

{
  "data": {
    "id": "ent-uuid-new",
    "name": "New Corporation",
    "country": "BR",
    "registration_number": "12.345.678/0001-90",
    "status": "active",
    "subscription_tier": "starter",
    "created_at": "2026-01-16T10:00:00Z"
  },
  "message": "Enterprise created successfully"
}

Update Enterprise

Endpoint

PATCH /api/v1/admin/enterprises/{enterprise_id}

Required Role

  • Super Admin

Request Body

{
  "status": "inactive",
  "subscription_tier": "professional"
}

Response

{
  "data": {
    "id": "ent-uuid-001",
    "status": "inactive",
    "subscription_tier": "professional",
    "updated_at": "2026-01-16T10:00:00Z"
  },
  "message": "Enterprise updated successfully"
}