RIrillet
Customer Families

Lists all customer families

Changed on

Returns customer families with pagination and optional search or update filters. The response does not include members; use list-customer-family-members to read them.

get/customer-families

Request

Query parameters

limitinteger

Maximum number of rows to return in the page.

cursorstring

If defined, a cursor to retrieve the next page.

Example:iLQvkEj3sh3UiweC

Pagination cursor to navigate through the full response.

searchstring

Filter customer families by name.

updated.gtstring date-time
Example:2023-01-01T00:00:00Z

Filter customer families updated after this timestamp

sort_by'created' | 'updated'

the field the customer families should be sorted by descending (either created or updated)

Response

OK

Example response

{
  "customer_families": [
    {
      "name": "Acme Holdings",
      "member_count": 4
    }
  ],
  "pagination": {
    "next_cursor": "iLQvkEj3sh3UiweC"
  }
}

Changes