Partner Endpoints

This endpoint lists the active portal users of the partner account.

get/partner/users

Request

  • Base URL
    https://earthnode-dev.vopay.com/api/v2
  • URL
    https://earthnode-dev.vopay.com/api/v2/partner/users
  • Auth
    none declared

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

PartnerAccountIDstring

APIAccountID of a partner account created by the caller. When set, the request acts on that partner account's portal users instead of the caller's. Requires PartnerCreationEnabled; returns RESOURCE_NOT_FOUND for a partner account the caller didn't create.

Response

Successboolean required

True if the request was successful, false if it failed

ErrorMessagestring required

Contains a description of the error if the request failed

Example response

{
  "Success": true,
  "Users": {
    "0": {
      "Username": "user@acme.example",
      "UserType": "Admin",
      "DateAdded": "2026-01-15 09:30:00"
    }
  }
}

Changes