| Field | Type | Required | Description | Example |
|---|---|---|---|---|
group_id |
Optional[str] | ➖ | A filter on the list based on the partner's groupId field. |
grp_123 |
status |
Optional[operations.ListPartnersQueryParamStatus] | ➖ | A filter on the list based on the partner's status field. |
approved |
country |
Optional[str] | ➖ | A filter on the list based on the partner's country field. |
US |
sort_by |
Optional[operations.ListPartnersQueryParamSortBy] | ➖ | The field to sort the partners by. The default is totalSaleAmount. |
totalSaleAmount |
sort_order |
Optional[operations.ListPartnersQueryParamSortOrder] | ➖ | The sort order. The default is desc. |
desc |
email |
Optional[str] | ➖ | Filter the partner list based on the partner's email. The value must be a string. Takes precedence over search. |
panic@thedis.co |
tenant_id |
Optional[str] | ➖ | Filter the partner list based on the partner's tenantId. The value must be a string. Takes precedence over email and search. |
1K0NM7HCN944PEMZ3CQPH43H8 |
search |
Optional[str] | ➖ | A search query to filter partners by ID, name, email, or link. | john |
page |
Optional[float] | ➖ | The page number for pagination. | 1 |
page_size |
Optional[float] | ➖ | The number of items per page. | 50 |