Get one Reseller

GET

api

sys

resellers

{id}

Get one Reseller

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/resellers/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/sys/resellers/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/resellers/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Name": "<string>",
  "UserId": 123,
  "UserFullName": "<string>",
  "UserEmail": "<string>",
  "CurrencyId": 123,
  "CurrencyCode": "<string>",
  "AgreedTermsOn": "<string>",
  "Approved": true,
  "AutoApprovePayouts": true,
  "NextPayoutDate": "<string>",
  "ProfileIsPublic": true,
  "AvatarFileName": "<string>",
  "NewAvatarUrl": "<string>",
  "ClearAvatarFile": true,
  "LogoFileName": "<string>",
  "NewLogoUrl": "<string>",
  "ClearLogoFile": true,
  "Area": "<string>",
  "OperatesIn": "<string>",
  "WebAddress": "<string>",
  "Email": "<string>",
  "ProfileSummary": "<string>",
  "PhoneNumber": "<string>",
  "Testimonial1": "<string>",
  "Testimonial1Author": "<string>",
  "Testimonial2": "<string>",
  "Testimonial2Author": "<string>",
  "StripeAccountId": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

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-Read role.

Path Parameters

integer

required

The Id of the Reseller record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/sys/resellers/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/resellers/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/resellers/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

string

The name value for this reseller.

integer

ID of the user linked to this record.

string

Display name of the linked user full (read-only).

string

The user email value for this reseller.

integer

ID of the currency linked to this record.

string

The currency code value for this reseller.

string

Date/time value for agreed terms on.

boolean

Whether approved is enabled.

boolean

Whether auto approve payouts is enabled.

string

Date/time value for next payout date.

boolean

Whether profile is public is enabled.

string

Current file name of the avatar (read-only; upload via the corresponding URL field).

string

URL of a new file to upload as the avatar.

boolean

Set to true to remove the current avatar file.

string

Current file name of the logo (read-only; upload via the corresponding URL field).

string

URL of a new file to upload as the logo.

boolean

Set to true to remove the current logo file.

string

The area value for this reseller.

string

The operates in value for this reseller.

string

The web address value for this reseller.

string

The email value for this reseller.

string

The profile summary value for this reseller.

string

The phone number value for this reseller.

string

The testimonial1 value for this reseller.

string

The testimonial1 author value for this reseller.

string

The testimonial2 value for this reseller.

string

The testimonial2 author value for this reseller.

string

ID of the stripe account associated with this record.

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

{
  "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,
  "ProfileSummary": null,
  "PhoneNumber": null,
  "Testimonial1": null,
  "Testimonial1Author": null,
  "Testimonial2": null,
  "Testimonial2Author": 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
}

Get multiple ResellersRetrieve multiple Reseller records by their Ids in a single request.

Get one Reseller

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/resellers/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/sys/resellers/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/resellers/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Name": "<string>",
  "UserId": 123,
  "UserFullName": "<string>",
  "UserEmail": "<string>",
  "CurrencyId": 123,
  "CurrencyCode": "<string>",
  "AgreedTermsOn": "<string>",
  "Approved": true,
  "AutoApprovePayouts": true,
  "NextPayoutDate": "<string>",
  "ProfileIsPublic": true,
  "AvatarFileName": "<string>",
  "NewAvatarUrl": "<string>",
  "ClearAvatarFile": true,
  "LogoFileName": "<string>",
  "NewLogoUrl": "<string>",
  "ClearLogoFile": true,
  "Area": "<string>",
  "OperatesIn": "<string>",
  "WebAddress": "<string>",
  "Email": "<string>",
  "ProfileSummary": "<string>",
  "PhoneNumber": "<string>",
  "Testimonial1": "<string>",
  "Testimonial1Author": "<string>",
  "Testimonial2": "<string>",
  "Testimonial2Author": "<string>",
  "StripeAccountId": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200