GET /item_families

Returns a list of item families satisfying all the conditions specified in the filter parameters below. The list is sorted by date of creation, in descending order.

Servers

{protocol}://{site}.{environment}:{port}/api/v2
{protocol}://{site}-test.{environment}:{port}/api/v2

Request headers

Name	Type	Required	Description
`chargebee-request-origin-device`	String	No	The device from which the customer has made the request
`chargebee-business-entity-id`	String	No	If the site has multiple business entities, you can use this custom HTTP header to specify the business entity for which Chargebee should perform the operation.
`chargebee-request-origin-user`	String	No	The email address of your customer/user. Use this when the email address has only ASCII characters.
`chargebee-request-origin-ip`	String	No	The IP address of the customer where the request originated
`chargebee-request-origin-user-encoded`	String	No	The Base64-encoded email address of your customer/user. Use this if the email address has UTF-8 characters. When this header is provided, the header `chargebee-request-origin-user` is ignored.

Query parameters

Name	Type	Required	Description
`id`	Object	No	optional, string filter The identifier for the item family. It is unique and immutable. Supported operators : is, is_not, starts_with, in, not_in Example → id[is] = "family-id"
`limit`	Integer	No	The number of resources to be returned. Default value: 10
`name`	Object	No	optional, string filter A unique display name for the item family. This is visible only in Chargebee and not to customers. Supported operators : is, is_not, starts_with Example → name[is_not] = "family-name"
`business_entity_id`	Object	No	optional, string filter The unique ID of the business entity of this `item_family`. Learn more about all the scenarios before using this filter. Supported operators : is, is_present Example → business_entity_id[is_present] = "true"
`include_site_level_resources`	Object	No	optional, boolean filter Default value is `true` . To exclude site-level resources in specific cases, set this parameter to `false`. Possible values are : true, false Supported operators : is Example → include_site_level_resources[is] = "null"
`offset`	String	No	Determines your position in the list for pagination. To ensure that the next page is retrieved correctly, always set `offset` to the value of `next_offset` obtained in the previous iteration of the API call.
`updated_at`	Object	No	optional, timestamp(UTC) in seconds filter When the item family was last updated. Supported operators : after, before, on, between Example → updated_at[before] = "1243545465"

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.