RIrillet
Customer Families

Retrieves a customer family

Changed on

Returns a single customer family with its name, root parent and member count. The response does not include members; use list-customer-family-members to read them.

get/customer-families/{customer_family_id}

Request

Path parameters

customer_family_idstring uuid required

UUID of the customer family to retrieve.

Response

OK

idstring uuid required
namestring required

Defaults to the root parent customer's name when omitted on create.

root_parent_customer_idstring uuid required

The customer at the top of the tree. Every family has exactly one. Not to be confused with a member's parent_customer_id, which points at whoever that member reports to.

member_countinteger required

How many customers are in the family, counting the one at the top. Always at least two.

Example response

{
  "name": "Acme Holdings",
  "member_count": 4
}

Changes