Skip to main content
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>'
{
  "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

id
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"

Response

200

Name
string
The name value for this reseller.
UserId
integer
ID of the user linked to this record.
UserFullName
string
Display name of the linked user full (read-only).
UserEmail
string
The user email value for this reseller.
CurrencyId
integer
ID of the currency linked to this record.
CurrencyCode
string
The currency code value for this reseller.
AgreedTermsOn
string
Date/time value for agreed terms on.
Approved
boolean
Whether approved is enabled.
AutoApprovePayouts
boolean
Whether auto approve payouts is enabled.
NextPayoutDate
string
Date/time value for next payout date.
ProfileIsPublic
boolean
Whether profile is public is enabled.
AvatarFileName
string
Current file name of the avatar (read-only; upload via the corresponding URL field).
NewAvatarUrl
string
URL of a new file to upload as the avatar.
ClearAvatarFile
boolean
Set to true to remove the current avatar file.
LogoFileName
string
Current file name of the logo (read-only; upload via the corresponding URL field).
NewLogoUrl
string
URL of a new file to upload as the logo.
ClearLogoFile
boolean
Set to true to remove the current logo file.
Area
string
The area value for this reseller.
OperatesIn
string
The operates in value for this reseller.
WebAddress
string
The web address value for this reseller.
Email
string
The email value for this reseller.
ProfileSummary
string
The profile summary value for this reseller.
PhoneNumber
string
The phone number value for this reseller.
Testimonial1
string
The testimonial1 value for this reseller.
Testimonial1Author
string
The testimonial1 author value for this reseller.
Testimonial2
string
The testimonial2 value for this reseller.
Testimonial2Author
string
The testimonial2 author value for this reseller.
StripeAccountId
string
ID of the stripe account associated with this record.
Id
integer
Unique record identifier.
UniqueId
string
UUID of the record.
CreatedOn
string
Date and time the record was created (ISO 8601).
UpdatedOn
string
Date and time the record was last updated (ISO 8601).
UpdatedBy
string
Email of the user who last updated this record.
IsNew
boolean
Whether the record was recently created.
SystemId
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
}