---
title: "Retrieve global counterparties"
method: GET
path: "/global-counterparties"
tags: ["counterparties"]
---

# Retrieve global counterparties

`GET /global-counterparties`

## Request

- Base URL: `https://api.moneyhub.co.uk/v2.0`
- URL: `https://api.moneyhub.co.uk/v2.0/global-counterparties`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/moneyhub/apis/moneyhub-data-api/docs/global-counterparties/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieves list of global counterparties. The counterpartiesVersion query param can be used to get different versions. For more info refer to https://docs.moneyhubenterprise.com/docs/counterparties-2

## Query parameters

- `limit` integer
- `offset` integer
- `counterpartiesVersion` 'v3' | 'v2'

## Response `200`

Successful Counterparties Response

- object
  - `data` GlobalCounterpartyV3[]
    - `id` string, uuid, required: The unique identifier for the counterparty.
    - `name` string, required: Name of the counterparty
    - `parentId` string, nullable: The unique identifier for the counterparty parent
    - `parentName` string, nullable: Name of the counterparty parent
    - `fullCompanyName` string, nullable: Company name
    - `logoUrl` string, nullable: Logo Url of counterparty
    - `website` string, nullable: Website url of counterparty
    - `merchantCategoryCode` string, nullable
    - `merchantCategoryDescription` string, nullable
    - `registeredLocation` string, nullable: Registered address of company
    - `categoryId` string, nullable: Category used to group similar counterparties
    - `analyticalCategory` string, nullable: DEPRECATED. Category used to group similar counterparties
    - `transactionCategoryId` string, nullable: Most appropriate transaction category id for transactions to this counterparty
    - `transactionCategory` string, nullable: Most appropriate transaction category name for transactions to this counterparty
  - `links` Links
    - `next` string, uri: The url to retrieve the next page of results from
    - `prev` string, uri: The url to retrieve the previous page of results from
    - `self` string, uri, required: The url of the current resource(s)
  - `meta` object

---

[API](https://skmtc.dev/moneyhub/apis/moneyhub-data-api.md) - [All operations](https://skmtc.dev/moneyhub/apis/moneyhub-data-api/llms.txt) - [OpenAPI document](https://skmtc.dev/moneyhub/apis/moneyhub-data-api/revisions/f2eb965eb9af?raw)
