RIrillet
Customer Families

Lists the members of a customer family

Changed on

Returns the members of a customer family with pagination. Each member names the member it reports to, so you can rebuild the tree. Newest first, not alphabetical.

get/customer-families/{customer_family_id}/members

Request

  • Base URL
    https://api.rillet.com
  • Auth
    HTTP bearer

Path parameters

customer_family_idstring uuid required

UUID of the customer family whose members are listed.

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 members by customer name.

parent_customer_idstring uuid

Return only the direct children of this member. Omit it to page the whole family. Passing a customer from a different family gives you an empty page rather than an error.

sort_by'created' | 'updated'

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

Response

OK

Example response

{
  "members": [
    {
      "name": "Acme EMEA"
    }
  ],
  "pagination": {
    "next_cursor": "iLQvkEj3sh3UiweC"
  }
}

Changes