ResellerAccounts
Search ResellerAccounts
Search and list ResellerAccount records with filtering, sorting, and pagination.
GET
Search ResellerAccounts
A ResellerAccount represents the financial account associated with a reseller, tracking commissions, payouts, and billing between Nexudus and the reseller partner.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the ResellerAccount-List role.Query Parameters
Pagination & Sorting
integer
default:"1"
The page number to retrieve.
integer
default:"25"
The number of records per page.
string
The property name to sort results by (e.g.
Name, CreatedOn).integer
Sort direction.
0 for ascending, 1 for descending.Filters
integer
Filter by iD of the reseller linked to this record.
integer
Filter by iD of the reseller currency associated with this record.
string
Filter by the reseller currency code value for this reseller account.
integer
Filter by iD of the business linked to this record.
string
Filter by display name of the linked business (read-only).
string
Filter by iD of the business pre auth associated with this record.
string
Filter by the business last4 digits value for this reseller account.
string
Filter by the business pre auth last error value for this reseller account.
boolean
Filter by whether business suspended is enabled.
string
Filter by date/time value for business next invoice.
string
Filter by date/time value for business trial expire date.
string
Filter by the business support tier value for this reseller account.
string
Filter by the business on boarding tier value for this reseller account.
boolean
Filter by whether approved is enabled.
number
Filter by the comission percentage value for this reseller account.
string
Filter by date/time value for next payout date.
string
Filter by date/time value for expiration date.
string
Filter by date/time value for last access.
number
Filter by the last invoice amount value for this reseller account.
number
Filter by the average invoice amount value for this reseller account.
boolean
Filter by whether can manage account is enabled.
boolean
Filter by whether provides first line support is enabled.
string
Filter by optional notes or comments about this reseller account.
string
Filter by the scope of work value for this reseller account.
Range Filters
integer
Filter by iD of the reseller currency associated with this record greater than or equal to this value.
integer
Filter by iD of the reseller currency associated with this record less than or equal to this value.
string
Filter by date/time value for business next invoice greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by date/time value for business next invoice less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by date/time value for business trial expire date greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by date/time value for business trial expire date less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.number
Filter by the comission percentage value for this reseller account greater than or equal to this value.
number
Filter by the comission percentage value for this reseller account less than or equal to this value.
string
Filter by date/time value for next payout date greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by date/time value for next payout date less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by date/time value for expiration date greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by date/time value for expiration date less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by date/time value for last access greater than or equal to this value. Format:
YYYY-MM-DDTHH:mm.string
Filter by date/time value for last access less than or equal to this value. Format:
YYYY-MM-DDTHH:mm.number
Filter by the last invoice amount value for this reseller account greater than or equal to this value.
number
Filter by the last invoice amount value for this reseller account less than or equal to this value.
number
Filter by the average invoice amount value for this reseller account greater than or equal to this value.
number
Filter by the average invoice amount value for this reseller account less than or equal to this value.
string
Filter records created on or after this date. Format:
YYYY-MM-DDTHH:mm.string
Filter records created on or before this date. Format:
YYYY-MM-DDTHH:mm.string
Filter records updated on or after this date. Format:
YYYY-MM-DDTHH:mm.string
Filter records updated on or before this date. Format:
YYYY-MM-DDTHH:mm.Code Examples
Simple listing
Filtering by CreatedOn
Range filters
Response
200
ResellerAccount[]
The list of ResellerAccount records matching the query. See the Get one ResellerAccount endpoint for the full list of properties returned for each record.
integer
Current page number.
integer
Number of records per page.
string
The field used for sorting.
integer
The sort direction (
0 = ascending, 1 = descending).integer
Index of the first item on the current page.
integer
Index of the last item on the current page.
integer
Total number of matching records across all pages.
integer
Total number of pages.
boolean
Whether there is a next page of results.
boolean
Whether there is a previous page of results.
Example Response
Search ResellerAccounts