Retrieve Counterparties Group Details

GET /api/v1/Counterparties/groups/:id

Description

This endpoint is used to retrieve details of a counterparty group by its ID.

Headers:

• None

ApiKey:

• No API key required

Content-Type:

• text/plain

• application/json

• text/json

Path Parameters:

• version: string, required

• id: string, required (format: UUID)

Query Parameters:

• None

Request Body:

• None

URL:

• GET: {{baseUrl API url}}/api/v1/Counterparties/groups/{id}

Response:

• A CounterpartyGroupResponse object containing the details of the requested counterparty group.

Error Codes:

• 400: Bad Request

• 404: Resource not found

• 500: Internal server error

Example:

Request:

GET /api/v1/Counterparties/groups/1234567890

Response:

HTTP/1.1 200 OK
{
  "id": "1234567890",
  "name": "Business Partners",
  "description": "Group for business partners",
  "count": 50,
  "counterparties": [
    {
      "id": "abc123",
      "name": "Business Partner 1",
      "type": "Vendor"
    },
    {
      "id": "def456",
      "name": "Business Partner 2",
      "type": "Customer"
    },
    ...
  ]
}

Method: GET

/api/v1/Counterparties/groups/:id

Headers

Content-Type	Value
Accept	text/plain

Response: 200

{
  "succeeded": "<boolean>",
  "message": "<string>",
  "errors": [
    "<string>",
    "<string>"
  ],
  "data": {
    "name": "<string>",
    "merchantId": "<uuid>",
    "id": "<uuid>"
  }
}