Jump to: GET Response Notes | API Call Builder
Find Cashflow Groups.
| Name | Type | Description |
|---|---|---|
| NetworkId | Url | Network ID |
| NetworkToken | String | Network token |
| Target | String | This calls action target |
| Method | String | This calls action method |
| filters | Filter | Array of field values to filter results byShow Filterable Fields |
| limit | Integer | Objects per page to return; defaults to returning all found |
| page | Integer | Result page to return, based on limit value; defaults to 1 |
| sort | Sort | Array of fields and directions to sort results byShow Sortable Fields |
| attach_rules | Boolean | Whether or not to attach the rules to each group as a 'rules' array field; note: If requested, the maximum limit allowed is 50 groups |
| attach_affiliate_ids | Boolean | Whether or not to attach the affiliate IDs assigned to each group is restricted to as an 'affiliate_ids' array; note: If requested, the maximum limit allowed is 50 groups |
GET Response Notes
Paginated results including cashflow groups and, if requested, nested rules and affiliates.
Return response will be in the following format: array.
API Call Builder
Javascript is required to use the API Call Builder.