Retrieve Counterparty Member

GET /api/v1/Counterparties/groups/members/:Id

Description

This endpoint is used to retrieve a specific counterparty group member by its Id. It returns a CounterpartyGroupMemberResponse object containing information about the member.

Headers:

• None

ApiKey:

• No API key required

Content-Type:

• text/plain

• application/json

• text/json

Path Parameters:

• version: string, required

• Id: string, required, the id of the counterparty group member to retrieve

Query Parameters:

• None

Request Body:

• None

URL:

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

Response:

• A CounterpartyGroupMemberResponse object containing information about the member.

Error Codes:

• 400: Bad Request

• 404: Resource not found

• 500: Internal server error

Example:

Request:

GET /api/v1/Counterparties/groups/members/1234567890

Response:

HTTP/1.1 200 OK
{
  "id": "1234567890",
  "name": "John Doe",
  "role": "Administrator"
}

Method: GET

/api/v1/Counterparties/groups/members/:Id

Headers

Content-Type	Value
Accept	text/plain

Response: 200

{
  "succeeded": "<boolean>",
  "message": "<string>",
  "errors": [
    "<string>",
    "<string>"
  ],
  "data": {
    "id": "<uuid>",
    "counterpartyId": "<uuid>",
    "counterpartyName": "<string>",
    "counterpartyGroupId": "<uuid>"
  }
}