1-Click PPA API

GET /v1/counterparties

Die Counterparty-Verbindungen des angemeldeten Unternehmens samt Verbindungsstatus auflisten. Nur aktive Counterparties in der Verkäuferrolle lassen sich als verbindliche Empfänger einer Anfrage adressieren. Erforderlicher Scope: rfq:read

Als Markdown anzeigen

Freischaltung erforderlich

Diese API muss für Ihr Konto explizit freigeschaltet werden. Wenden Sie sich dazu an den Support.
GET
/v1/counterparties
X-Api-Key<token>

In: header

Query Parameters

status?string

Nach Verbindungsstatus filtern

Value in"invited" | "onboarding" | "confirmation" | "active" | "declined" | "ended"
role?string

Nach einer aktivierten Rolle der Counterparty filtern

Value in"buyer" | "seller"
limit?integer

Höchstzahl der Einträge pro Seite

Default10
Range1 <= value <= 100
after?string

Cursor für die nächste Seite — den Wert next_cursor aus der vorherigen Antwort übergeben

Response Body

curl -X GET "https://api.otark.com/v1/counterparties?status=invited&role=buyer&limit=10&after=cpt_a1b2c3d4"
{
  "counterparties": [
    {
      "id": "cpt_5m8k2r6d",
      "company_id": "cmp_7d3f9k2a",
      "company_name": "Solar Nord",
      "status": "active",
      "roles": [
        "seller"
      ],
      "offers_granular_certificates": true,
      "contract_language": "de",
      "election_sheet": true,
      "general_agreement_date": "2026-05-04",
      "invited_at": "2026-04-28T09:12:00Z",
      "activated_at": "2026-05-04T14:30:00Z"
    }
  ],
  "pagination": {
    "limit": 10,
    "has_more": true,
    "next_cursor": "rfq_k8m2p4q7"
  }
}

{
  "type": "https://api.otark.com/errors/validation",
  "title": "Validierung fehlgeschlagen",
  "status": 400,
  "instance": "/v1/rfqs",
  "errors": [
    {
      "field": "nominal_power",
      "code": "value_too_small",
      "message": "Nominal power must be at least 1 MW"
    }
  ]
}

{
  "type": "https://api.otark.com/errors/invalid_api_key",
  "title": "Ungültiger API-Schlüssel",
  "status": 401
}

{
  "type": "https://api.otark.com/errors/insufficient_scopes",
  "title": "Unzureichende Scopes des API-Schlüssels",
  "status": 403,
  "detail": "Missing scope: rfq:write. Please create a new API key with the required scopes."
}