MOmonato
Business Units

List Business Units

Changed on

Returns the Customers/Business Units associated with a client. In production, use only customers where customerValidationStatus = VALIDATED.

get/v1/clients/{clientId}/customers

Request

Path parameters

clientIdstring uuid required
Example:c2d1d1e3-3340-4170-980e-e9269bbbc551

Client UUID.

Query parameters

customer_status'ACTIVE' | 'INACTIVE' | 'BLOCKED'
Example:ACTIVE

Filter Business Units by lifecycle status.

customer_aliasstring

Filter Business Units by alias. Matching behavior is backend-defined.

namestring

Filter Business Units by legal or display name.

customer_validation_status'PENDING' | 'VALIDATED' | 'REJECTED'
Example:VALIDATED

Filter Business Units by validation status.

pageinteger

Page number to return. The first page is 1.

per_pageinteger

Number of Business Units returned per page.

Response

Business Units list.

currentPageinteger

Current page number.

perPageinteger

Number of Business Units returned per page.

totalItemsinteger

Total number of Business Units matching the request.

Example response

{
  "currentPage": 1,
  "perPage": 50,
  "totalItems": 3,
  "data": [
    {
      "id": "bb1e8fde-e68e-48e9-a483-d32153c752c2",
      "clientId": "c2d1d1e3-3340-4170-980e-e9269bbbc551",
      "name": "Business Unit ABC",
      "rfc": "XAXX010101000",
      "legalRepresentativeName": "Jane Doe",
      "legalRepresentativeRfc": "XAXX010101000",
      "legalRepresentativePhone": "5555555555",
      "legalRepresentativeEmail": "legal@example.com",
      "website": "https://example.com",
      "domain": "example.com",
      "customerAlias": "BU ABC",
      "customerStatus": "ACTIVE",
      "customerValidationStatus": "VALIDATED",
      "audit": {
        "createdAt": "2025-03-05 11:00:56.264527-06:00",
        "updatedAt": "2025-03-05 11:00:56.264527-06:00",
        "deletedAt": "None",
        "blockedAt": "None"
      }
    }
  ]
}

Changes