Get Accounts

​

Get all accounts

Query Parameters
  • sort_type
    Type: string · Sort Typeenum

    Ordering of the returned accounts. 'flat' (default) returns all descendant accounts as a flat list; 'hierarchy' nests each account's descendants under children, ordered server-side, so clients don't have to build the tree themselves.

    values
    • flat
    • hierarchy
  • status
    Type: array string[] | null · Statusenum

    Account statuses to include (repeatable). Defaults to active + inactive when omitted (soft-deleted excluded). deleted matches soft-deleted accounts (deleted_at set).

    values
    • active
    • inactive
    • blocked
    • deleted
  • account_type
    Type: array string[] | null · Account Typeenum

    Filter to these account types (repeatable, any-of). Omit for all types.

    values
    • merchant
    • partner
    • psp
  • sort_by
    Type: string · Sort Byenum

    Sort siblings by account name (default) or rolling 7-day transaction volume. Volume sort uses the rolled-up subtree total.

    values
    • name
    • volume
  • sort_order
    Type: string · Sort Orderenum

    Sort direction for sort_by.

    values
    • asc
    • desc
  • with_data
    Type: boolean · With Data

    When true, attach transaction_stats (rolling 7-day vs prior 7-day transaction count & volume) to each returned account, rolled up through the hierarchy. Computed in a single aggregate query.

  • with_processors
    Type: boolean · With Processors

    When true, attach available_processors (the full ProcessorConfig details joined from each account's available_processor_configs) to every returned account. Resolved in a single bulk query across all accounts. None on every account when false.

Headers
  • Accept
    enum
    const:  
    application/json
    required

    Response format. Must be application/json.

    values
    • application/json
Responses
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for get/v2/accounts
curl https://api.uat.koard.com/v2/accounts \
  --header 'Accept: application/json' \
  --header 'x-koard-apikey: YOUR_SECRET_TOKEN'

[
  {
    "address": {
      "city": "string",
      "state": "string",
      "street_line1": "string",
      "street_line2": "",
      "zip": "string",
      "country": "US"
    },
    "available_processor_configs": [],
    "created_at": "2026-08-14T15:02:48.704Z",
    "deleted_at": null,
    "description": "string",
    "has_access_to_apple_config": false,
    "id": "string",
    "mcc": null,
    "name": "string",
    "organization_id": null,
    "parent_account_ids": [],
    "status": "active",
    "surcharge_rate": null,
    "surcharge_basis": "total",
    "surcharge_confirmation_required": null,
    "tax_rate": null,
    "tax_basis": "total",
    "tax_id": null,
    "type": "psp",
    "updated_at": null
  }
]

Successful Response