---
title: "partner/partners"
method: GET
path: "/partner/partners"
tags: ["Partner Endpoints"]
---

# partner/partners

`GET /partner/partners`

## Request

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

This endpoint returns the partner accounts created by the calling partner. Requires the PartnerCreationEnabled permission. With ExportCSV=true the listing is returned as a base64 CSV file instead of JSON rows; the CSV columns are Date Added, Partner Name, Partner Account ID, Status, Status Date, Country, Accounts, followed by one "Total Balance (XXX)" column per currency.

## Query parameters

- `AccountID` string, required
- `Key` string, required
- `Signature` string, required
- `Limit` integer
- `Offset` integer
- `AccountStatus` string
- `SearchText` string
- `ShowToken` boolean
- `ExportCSV` boolean

## Response `200`

- object
  - `Success` boolean, required: True if the request was successful, false if it failed
  - `ErrorMessage` string, required: Contains a description of the error if the request failed
  - `Partners` object: Array serialized as a JSON object (JSON_FORCE_OBJECT): numeric string keys '0','1',... Empty {} when no items.
    - `0` object
      - `PartnerAccountID` string, required: APIAccountID of the partner account. Use it as PartnerAccountID on the other /partner/partners endpoints.
      - `Name` string, required: Partner account name
      - `AccountStatus` string, nullable, required: Current onboarding status of the partner account
      - `Country` string, required: Country of the partner account
      - `EmailAddress` string, email, required: Email address of the partner account
      - `IsActive` boolean, required: Whether the partner account is active
      - `DateAdded` string, required: Date the partner account was created
      - `Currency` string, required: Currency of the partner account, short form
      - `AccountCount` integer, required: Number of parent accounts under the partner account. Sub-accounts and Interest accounts are excluded.
      - `TotalBalances` object, required: Total balance per currency, keyed by currency short form. Values are decimal strings. Interest and Technology accounts are excluded.
      - `AccountStatusDate` string, nullable, required: Date the partner account entered its current status. Falls back to DateAdded when no status change is recorded.
      - `DateActivated` string, nullable, required: Date the partner account was first activated
      - `Token` string: Partner dashboard access token, valid for 24 hours.
  - `PaginationMetaData` object: Pagination metadata
    - `TotalRecords` integer, required: Total number of partner account records in that search range.
    - `Offset` integer, required: Use this parameter to set the starting point in the dataset.
    - `Limit` integer, required: Limit the number of records that are returned.
  - `CSVFile` string: Base64 data URI of the CSV file.

## Changes

- **2026-11-03** `71f251deb318`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/vopay/apis/accounts/changes/partner/partners/get.md)

---

[API](https://skmtc.dev/vopay/apis/accounts.md) - [All operations](https://skmtc.dev/vopay/apis/accounts/llms.txt) - [OpenAPI document](https://skmtc.dev/vopay/apis/accounts/revisions/71f251deb318?raw)