Business Units

Retrieve a Business Unit

Changed on

Returns a single Customer/Business Unit by ID.

get/v1/clients/{clientId}/customers/{id}

Request

Path parameters

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

Client UUID.

idstring uuid required

Customer UUID.

Response

Business Unit details.

idstring uuid required

Business Unit UUID.

clientIdstring uuid required

Client UUID that owns the Business Unit.

namestring required

Legal name of the Business Unit.

rfcstring required

RFC tax identifier of the Business Unit.

legalRepresentativeNamestring required

Full name of the legal representative.

legalRepresentativeRfcstring required

RFC tax identifier of the legal representative.

legalRepresentativePhonestring required

Contact phone number of the legal representative.

legalRepresentativeEmailstring email required

Contact email of the legal representative.

websitestring uri

Business Unit website when available.

domainstring

Business Unit domain when available.

customerAliasstring

Short alias used to identify the Business Unit.

customerStatus'ACTIVE' | 'INACTIVE' | 'BLOCKED'
customerValidationStatus'PENDING' | 'VALIDATED' | 'REJECTED'

Example response

{
  "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