Skip to main content
GET
/
api
/
sys
/
resellers
Search Resellers
curl --request GET \
  --url https://spaces.nexudus.com/api/sys/resellers \
  --header 'Authorization: Basic <encoded-value>'
{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}
A Reseller represents a partner organisation that resells Nexudus services or manages multiple business locations on behalf of their clients.

​
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 Reseller-List role.

​
Query Parameters

​
Pagination & Sorting

​
page
integer
default:"1"
The page number to retrieve.
​
size
integer
default:"25"
The number of records per page.
​
orderBy
string
The property name to sort results by (e.g. Name, CreatedOn).
​
dir
integer
Sort direction. 0 for ascending, 1 for descending.

​
Filters

​
Reseller_Name
string
Filter by the name value for this reseller.
​
Reseller_User
integer
Filter by iD of the user linked to this record.
​
Reseller_User_FullName
string
Filter by display name of the linked user full (read-only).
​
Reseller_User_Email
string
Filter by the user email value for this reseller.
​
Reseller_Currency
integer
Filter by iD of the currency linked to this record.
​
Reseller_Currency_Code
string
Filter by the currency code value for this reseller.
​
Reseller_AgreedTermsOn
string
Filter by date/time value for agreed terms on.
​
Reseller_Approved
boolean
Filter by whether approved is enabled.
​
Reseller_AutoApprovePayouts
boolean
Filter by whether auto approve payouts is enabled.
​
Reseller_NextPayoutDate
string
Filter by date/time value for next payout date.
​
Reseller_ProfileIsPublic
boolean
Filter by whether profile is public is enabled.
​
Reseller_AvatarFileName
string
Filter by current file name of the avatar (read-only; upload via the corresponding URL field).
​
Reseller_NewAvatarUrl
string
Filter by uRL of a new file to upload as the avatar.
​
Reseller_ClearAvatar
boolean
Filter by set to true to remove the current avatar file.
​
Reseller_LogoFileName
string
Filter by current file name of the logo (read-only; upload via the corresponding URL field).
​
Reseller_NewLogoUrl
string
Filter by uRL of a new file to upload as the logo.
Filter by set to true to remove the current logo file.
​
Reseller_Area
string
Filter by the area value for this reseller.
​
Reseller_OperatesIn
string
Filter by the operates in value for this reseller.
​
Reseller_WebAddress
string
Filter by the web address value for this reseller.
​
Reseller_Email
string
Filter by the email value for this reseller.
​
Reseller_ProfileSummary
string
Filter by the profile summary value for this reseller.
​
Reseller_PhoneNumber
string
Filter by the phone number value for this reseller.
​
Reseller_Testimonial1
string
Filter by the testimonial1 value for this reseller.
​
Reseller_Testimonial1Author
string
Filter by the testimonial1 author value for this reseller.
​
Reseller_Testimonial2
string
Filter by the testimonial2 value for this reseller.
​
Reseller_Testimonial2Author
string
Filter by the testimonial2 author value for this reseller.
​
Reseller_StripeAccountId
string
Filter by iD of the stripe account associated with this record.

​
Range Filters

​
from_Reseller_AgreedTermsOn
string
Filter by date/time value for agreed terms on greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
to_Reseller_AgreedTermsOn
string
Filter by date/time value for agreed terms on less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
from_Reseller_NextPayoutDate
string
Filter by date/time value for next payout date greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
to_Reseller_NextPayoutDate
string
Filter by date/time value for next payout date less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
from_Reseller_CreatedOn
string
Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.
​
to_Reseller_CreatedOn
string
Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.
​
from_Reseller_UpdatedOn
string
Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.
​
to_Reseller_UpdatedOn
string
Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

​
Code Examples

​
Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/sys/resellers?page=1&size=15&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Filtering by Name

curl -X GET \
  "https://spaces.nexudus.com/api/sys/resellers?Reseller_Name=example-value&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/sys/resellers?from_Reseller_UpdatedOn=2025-01-01T00:00&to_Reseller_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Response

​
200

​
Records
Reseller[]
The list of Reseller records matching the query. See the Get one Reseller endpoint for the full list of properties returned for each record.
Partial records — The listing endpoint returns a summary representation of each Reseller. The following fields are not populated in the Records[] response: ProfileSummary, PhoneNumber, Testimonial1, Testimonial1Author, Testimonial2, Testimonial2Author.To get all fields, fetch the full record using the Get one Reseller endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.
​
CurrentPage
integer
Current page number.
​
CurrentPageSize
integer
Number of records per page.
​
CurrentOrderField
string
The field used for sorting.
​
CurrentSortDirection
integer
The sort direction (0 = ascending, 1 = descending).
​
FirstItem
integer
Index of the first item on the current page.
​
LastItem
integer
Index of the last item on the current page.
​
TotalItems
integer
Total number of matching records across all pages.
​
TotalPages
integer
Total number of pages.
​
HasNextPage
boolean
Whether there is a next page of results.
​
HasPreviousPage
boolean
Whether there is a previous page of results.
Example Response
{
  "Records": [
    {
      "Name": "",
      "UserId": 0,
      "UserFullName": null,
      "UserEmail": null,
      "CurrencyId": 0,
      "CurrencyCode": null,
      "AgreedTermsOn": null,
      "Approved": false,
      "AutoApprovePayouts": false,
      "NextPayoutDate": null,
      "ProfileIsPublic": false,
      "AvatarFileName": null,
      "NewAvatarUrl": null,
      "ClearAvatarFile": null,
      "LogoFileName": null,
      "NewLogoUrl": null,
      "ClearLogoFile": null,
      "Area": null,
      "OperatesIn": null,
      "WebAddress": null,
      "Email": null,
      "StripeAccountId": null,
      "Id": 87654321,
      "UpdatedOn": "2025-01-15T10:30:00Z",
      "CreatedOn": "2025-01-10T08:00:00Z",
      "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "UpdatedBy": "admin@example.com",
      "IsNew": false,
      "SystemId": null,
      "ToStringText": "Reseller Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}