latestOpenAPI 3.0.32026-08-20146131.7 MB

672b1916ba61

Counterparties

Get counterparty field options

Returns the enum option sets and country list needed to build a counterparty form.

get/v1/counterparties/metadata

Headers

x-project-idstring

Selects the active project for this request. Required for session/dashboard callers. Ignored when authenticating with an API key, whose scope is fixed to the key's project.

Example:prj_example

Selects the active project for this request. Required for session/dashboard callers. Ignored when authenticating with an API key, whose scope is fixed to the key's project.

Response

Counterparty field options

Example response

{
  "data": {
    "fields": {
      "countries": [
        {
          "code": "US",
          "name": "United States"
        }
      ],
      "usStates": [
        {
          "code": "US",
          "name": "United States"
        }
      ]
    }
  },
  "meta": {
    "requestId": "req_example",
    "timestamp": "2025-01-01T00:00:00.000Z"
  }
}