> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Search Resellers

> Search and list Reseller records with filtering, sorting, and pagination.

A **Reseller** represents a partner organisation that resells Nexudus services or manages multiple business locations on behalf of their clients.

## Authentication

<Note>
  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.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField query="page" type="integer" default="1">
  The page number to retrieve.
</ParamField>

<ParamField query="size" type="integer" default="25">
  The number of records per page.
</ParamField>

<ParamField query="orderBy" type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField query="dir" type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField query="Reseller_Name" type="string">
  Filter by the name value for this reseller.
</ParamField>

<ParamField query="Reseller_User" type="integer">
  Filter by iD of the user linked to this record.
</ParamField>

<ParamField query="Reseller_User_FullName" type="string">
  Filter by display name of the linked user full (read-only).
</ParamField>

<ParamField query="Reseller_User_Email" type="string">
  Filter by the user email value for this reseller.
</ParamField>

<ParamField query="Reseller_Currency" type="integer">
  Filter by iD of the currency linked to this record.
</ParamField>

<ParamField query="Reseller_Currency_Code" type="string">
  Filter by the currency code value for this reseller.
</ParamField>

<ParamField query="Reseller_AgreedTermsOn" type="string">
  Filter by date/time value for agreed terms on.
</ParamField>

<ParamField query="Reseller_Approved" type="boolean">
  Filter by whether approved is enabled.
</ParamField>

<ParamField query="Reseller_AutoApprovePayouts" type="boolean">
  Filter by whether auto approve payouts is enabled.
</ParamField>

<ParamField query="Reseller_NextPayoutDate" type="string">
  Filter by date/time value for next payout date.
</ParamField>

<ParamField query="Reseller_ProfileIsPublic" type="boolean">
  Filter by whether profile is public is enabled.
</ParamField>

<ParamField query="Reseller_AvatarFileName" type="string">
  Filter by current file name of the avatar (read-only; upload via the corresponding URL field).
</ParamField>

<ParamField query="Reseller_NewAvatarUrl" type="string">
  Filter by uRL of a new file to upload as the avatar.
</ParamField>

<ParamField query="Reseller_ClearAvatar" type="boolean">
  Filter by set to true to remove the current avatar file.
</ParamField>

<ParamField query="Reseller_LogoFileName" type="string">
  Filter by current file name of the logo (read-only; upload via the corresponding URL field).
</ParamField>

<ParamField query="Reseller_NewLogoUrl" type="string">
  Filter by uRL of a new file to upload as the logo.
</ParamField>

<ParamField query="Reseller_ClearLogo" type="boolean">
  Filter by set to true to remove the current logo file.
</ParamField>

<ParamField query="Reseller_Area" type="string">
  Filter by the area value for this reseller.
</ParamField>

<ParamField query="Reseller_OperatesIn" type="string">
  Filter by the operates in value for this reseller.
</ParamField>

<ParamField query="Reseller_WebAddress" type="string">
  Filter by the web address value for this reseller.
</ParamField>

<ParamField query="Reseller_Email" type="string">
  Filter by the email value for this reseller.
</ParamField>

<ParamField query="Reseller_ProfileSummary" type="string">
  Filter by the profile summary value for this reseller.
</ParamField>

<ParamField query="Reseller_PhoneNumber" type="string">
  Filter by the phone number value for this reseller.
</ParamField>

<ParamField query="Reseller_Testimonial1" type="string">
  Filter by the testimonial1 value for this reseller.
</ParamField>

<ParamField query="Reseller_Testimonial1Author" type="string">
  Filter by the testimonial1 author value for this reseller.
</ParamField>

<ParamField query="Reseller_Testimonial2" type="string">
  Filter by the testimonial2 value for this reseller.
</ParamField>

<ParamField query="Reseller_Testimonial2Author" type="string">
  Filter by the testimonial2 author value for this reseller.
</ParamField>

<ParamField query="Reseller_StripeAccountId" type="string">
  Filter by iD of the stripe account associated with this record.
</ParamField>

### Range Filters

<ParamField query="from_Reseller_AgreedTermsOn" type="string">
  Filter by date/time value for agreed terms on greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_Reseller_AgreedTermsOn" type="string">
  Filter by date/time value for agreed terms on less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_Reseller_NextPayoutDate" type="string">
  Filter by date/time value for next payout date greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_Reseller_NextPayoutDate" type="string">
  Filter by date/time value for next payout date less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_Reseller_CreatedOn" type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_Reseller_CreatedOn" type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_Reseller_UpdatedOn" type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_Reseller_UpdatedOn" type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/sys/resellers?page=1&size=15&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/sys/resellers?' + new URLSearchParams({
      page: 1,
      size: 15,
      orderBy: 'Name',
      dir: 1 // Ascending
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/sys/resellers',
      params={
          'page': 1,
          'size': 15,
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Filtering by Name

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/sys/resellers?Reseller_Name=example-value&orderBy=Name&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/sys/resellers?' + new URLSearchParams({
      Reseller_Name: 'example-value',
      orderBy: 'Name',
      dir: 1
    }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/sys/resellers',
      params={
          'Reseller_Name': 'example-value',
          'orderBy': 'Name',
          'dir': 0 // Ascending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  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"
  ```

  ```javascript JavaScript theme={null}
  const response = await fetch(
    'https://spaces.nexudus.com/api/sys/resellers?' + new URLSearchParams({
      from_Reseller_UpdatedOn: '2025-01-01T00:00',
      to_Reseller_UpdatedOn: '2025-12-31T23:59',
      orderBy: 'UpdatedOn',
      dir: 1 // Descending
     }),
    {
      headers: {
        'Authorization': 'Bearer YOUR_TOKEN'
      }
    }
  );

  const data = await response.json();
  ```

  ```python Python theme={null}
  import requests

  response = requests.get(
      'https://spaces.nexudus.com/api/sys/resellers',
      params={
          'from_Reseller_UpdatedOn': '2025-01-01T00:00',
          'to_Reseller_UpdatedOn': '2025-12-31T23:59',
          'orderBy': 'UpdatedOn',
          'dir': 1 // Descending
      },
      headers={
          'Authorization': 'Bearer YOUR_TOKEN'
      }
  )

  data = response.json()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="Reseller[]">
  The list of Reseller records matching the query. See the [Get one Reseller](/rest-api/sys/get-resellers-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<Warning>
  **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](/rest-api/sys/get-resellers-by-id) 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.
</Warning>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "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
}
```