Counterparties

A request to retrieve a list of accounts in the registry that are valid for certificate transfers. This should be all NAR accounts that can buy or sell certificates (this will not include MA Biomass accounts).

SecurityJWT
Request
query Parameters
counterpartyAccountIds
Array of integers <int32>

Counterparty account ids: if specified, limits the results to the counterparty accounts whose ids match the provided set

$filter
string

OData-like filter expression

$orderby
string

Comma-separated list of columns for sorting

$skip
integer <int32>

Number of records to skip

$top
integer <int32>

Maximum number of records to return

$apply
string

OData-like apply expression with groupby and aggregate only

Responses
200

Success

400

Invalid parameter(s)

401

Unauthorized access

403

Permission denied

429

Server too busy or acceptable use policy violation

500

An unexpected error has occurred

get/api/account/counterparty
Response samples
application/json
{
  • "@count": 0,
  • "value": [
    ],
  • "totalCount": 0,
  • "countExceeded": true
}