List counterparties

Lists counterparties for the authenticated organization.

GET/v1/counterpartiesRun in dashboard

Requires an API key with the counterparties.read action.

Query parameters

  • page · integer · greater than 0 · default 1 · example 1

    Page number (1-based).

  • pageSize · integer · min 1 · max 100 · default 20 · example 20

    Items per page (max 100).

  • includeArchived · boolean · example false

    Include archived counterparties in results.

Headers

  • x-project-id · string · min length 1 · example prj_example

    Required for dashboard sessions. API keys use their assigned project.

Responses

  • 200 Counterparties list

    • data · object · required

      Paginated list of counterparties.

      • counterparties · object[] · required

        Counterparties.

        • id · string · required · min length 1 · example cpty_example

          Counterparty identifier.

        • organizationId · string · required · min length 1 · example org_example

          Organization identifier.

        • projectId · string | null · required · min length 1 · example prj_example

          Project scope when the counterparty is project-scoped.

        • externalId · string | null · required · example customer_42

          Caller-supplied opaque identifier for cross-system reference. Do not place personal data in this indexed field.

        • entityType · string · required · one of individual, business · example individual

          Counterparty entity type.

        • displayName · string · required · example Jane Doe

          Human-readable, searchable display name. Keep it minimal because this indexed field is not application-encrypted.

        • status · string · required · one of active, archived · example active

          Counterparty status.

        • createdBy · string | null · required · min length 1 · example usr_example

          User who created the counterparty. Null when created via API key.

        • createdAt · string · required · format date-time · example 2025-01-01T00:00:00.000Z

          Creation timestamp.

        • updatedAt · string · required · format date-time · example 2025-01-02T00:00:00.000Z

          Last update timestamp.

      • total · integer · required · min 0 · example 42

        Total counterparties matching the query.

      • page · integer · required · greater than 0 · example 1

        Current page number.

      • pageSize · integer · required · greater than 0 · example 20

        Items per page.

    • meta · object · required

      Response metadata.

      • requestId · string · required · min length 1 · example req_example

        Request identifier for tracing.

      • timestamp · string · required · format date-time · example 2025-01-01T00:00:00.000Z

        ISO 8601 timestamp.

  • 400 Bad Request

    • error · object · required

      Standard error payload.

      • code · string · required

        Machine-readable error code.

      • message · string · required

        Human-readable error message.

      • details · object

        Optional error details for debugging.

        • * · any

    • meta · object

      • requestId · string · min length 1 · example req_example

        Request identifier for tracing.

  • 401 Unauthorized

    Same fields as 400.

  • 403 Forbidden. Requires the counterparties.read action: an API key must hold it (a module's manage or execute also covers its read), and a signed-in member's organization role must include it. Without it the error is INSUFFICIENT_PERMISSIONS and error.details.action names the action. Any other 403 names its own reason.

    Same fields as 400.

  • 500 Internal Server Error

    Same fields as 400.

Example request

curl 'https://api.solana.com/v1/counterparties' \
  -H "Authorization: Bearer $SDP_API_KEY"

Example responses

{
  "data": {
    "counterparties": [
      {
        "id": "cpty_example",
        "organizationId": "org_example",
        "projectId": "prj_example",
        "externalId": "customer_42",
        "entityType": "individual",
        "displayName": "Jane Doe",
        "status": "active",
        "createdBy": "usr_example",
        "createdAt": "2025-01-01T00:00:00.000Z",
        "updatedAt": "2025-01-02T00:00:00.000Z"
      }
    ],
    "total": 42,
    "page": 1,
    "pageSize": 20
  },
  "meta": {
    "requestId": "req_example",
    "timestamp": "2025-01-01T00:00:00.000Z"
  }
}

Error responses use the standard error shape.

Is this page helpful?