List counterparties

Request

List counterparties

Security

TokenAuth

Query

pageSizeinteger, (int32)

The number of results to return per page (default 50, max 1000)

pageTokenstring

The token to retrieve the next page of results

pagination.pageSizeinteger, (int32)

Number of results per page (default 50, max 1000)

pagination.pageTokenstring

Token for pagination from previous response

pagination.orderBystring

Field to order results by

pagination.orderstring

Sort order (ASC or DESC)

Enum:"SORT_ORDER_ASC""SORT_ORDER_DESC"

filter.id.eqstring

Exact match

filter.id.notEqstring

Not equal to

filter.id.containsstring

Contains substring (case-insensitive)

filter.id.startsWithstring

Starts with prefix (case-insensitive)

filter.id.endsWithstring

Ends with suffix (case-insensitive)

filter.id.inArray of strings

Value is in the list

filter.id.notInArray of strings

Value is not in the list

filter.id.isNullboolean

Check if field is null

filter.name.eqstring

Exact match

filter.name.notEqstring

Not equal to

filter.name.containsstring

Contains substring (case-insensitive)

filter.name.startsWithstring

Starts with prefix (case-insensitive)

filter.name.endsWithstring

Ends with suffix (case-insensitive)

filter.name.inArray of strings

Value is in the list

filter.name.notInArray of strings

Value is not in the list

filter.name.isNullboolean

Check if field is null

filter.description.eqstring

Exact match

filter.description.notEqstring

Not equal to

filter.description.containsstring

Contains substring (case-insensitive)

filter.description.startsWithstring

Starts with prefix (case-insensitive)

filter.description.endsWithstring

Ends with suffix (case-insensitive)

filter.description.inArray of strings

Value is in the list

filter.description.notInArray of strings

Value is not in the list

filter.description.isNullboolean

Check if field is null

filter.typestring

Filter by counterparty type

Enum:"ORGANIZATION""INDIVIDUAL""DAPP"

filter.createdAt.eqstring, (date-time)

Exact timestamp match

filter.createdAt.notEqstring, (date-time)

Not equal to timestamp

filter.createdAt.beforestring, (date-time)

Before this timestamp

filter.createdAt.afterstring, (date-time)

After this timestamp

filter.createdAt.gtestring, (date-time)

Greater than or equal to timestamp

filter.createdAt.ltestring, (date-time)

Less than or equal to timestamp

filter.createdAt.between.startstring, (date-time)

Start of time range (inclusive)

filter.createdAt.between.endstring, (date-time)

End of time range (inclusive)

filter.createdAt.isNullboolean

Check if field is null

filter.createdAt.relativeDaysinteger, (int32)

Relative days from now (negative for past, positive for future)

filter.updatedAt.eqstring, (date-time)

Exact timestamp match

filter.updatedAt.notEqstring, (date-time)

Not equal to timestamp

filter.updatedAt.beforestring, (date-time)

Before this timestamp

filter.updatedAt.afterstring, (date-time)

After this timestamp

filter.updatedAt.gtestring, (date-time)

Greater than or equal to timestamp

filter.updatedAt.ltestring, (date-time)

Less than or equal to timestamp

filter.updatedAt.between.startstring, (date-time)

Start of time range (inclusive)

filter.updatedAt.between.endstring, (date-time)

End of time range (inclusive)

filter.updatedAt.isNullboolean

Check if field is null

filter.updatedAt.relativeDaysinteger, (int32)

Relative days from now (negative for past, positive for future)

searchstring

Case-insensitive search over counterparty ID, name, description, and counterparty details.

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/wallet/api-docs/palisade-api/palisade-api/v2/counterparties?pageSize=0&pageToken=string&pagination.pageSize=0&pagination.pageToken=string&pagination.orderBy=string&pagination.order=SORT_ORDER_ASC&filter.id.eq=string&filter.id.notEq=string&filter.id.contains=string&filter.id.startsWith=string&filter.id.endsWith=string&filter.id.in=string&filter.id.notIn=string&filter.id.isNull=true&filter.name.eq=string&filter.name.notEq=string&filter.name.contains=string&filter.name.startsWith=string&filter.name.endsWith=string&filter.name.in=string&filter.name.notIn=string&filter.name.isNull=true&filter.description.eq=string&filter.description.notEq=string&filter.description.contains=string&filter.description.startsWith=string&filter.description.endsWith=string&filter.description.in=string&filter.description.notIn=string&filter.description.isNull=true&filter.type=ORGANIZATION&filter.createdAt.eq=2019-08-24T14%3A15%3A22Z&filter.createdAt.notEq=2019-08-24T14%3A15%3A22Z&filter.createdAt.before=2019-08-24T14%3A15%3A22Z&filter.createdAt.after=2019-08-24T14%3A15%3A22Z&filter.createdAt.gte=2019-08-24T14%3A15%3A22Z&filter.createdAt.lte=2019-08-24T14%3A15%3A22Z&filter.createdAt.between.start=2019-08-24T14%3A15%3A22Z&filter.createdAt.between.end=2019-08-24T14%3A15%3A22Z&filter.createdAt.isNull=true&filter.createdAt.relativeDays=0&filter.updatedAt.eq=2019-08-24T14%3A15%3A22Z&filter.updatedAt.notEq=2019-08-24T14%3A15%3A22Z&filter.updatedAt.before=2019-08-24T14%3A15%3A22Z&filter.updatedAt.after=2019-08-24T14%3A15%3A22Z&filter.updatedAt.gte=2019-08-24T14%3A15%3A22Z&filter.updatedAt.lte=2019-08-24T14%3A15%3A22Z&filter.updatedAt.between.start=2019-08-24T14%3A15%3A22Z&filter.updatedAt.between.end=2019-08-24T14%3A15%3A22Z&filter.updatedAt.isNull=true&filter.updatedAt.relativeDays=0&search=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

A successful response.

Bodyapplication/json

filterobject(v2FilterResponse)

counterpartiesArray of objects(v2Counterparty)

Response

{
  "filter": {
    "previousPageToken": "cGFnZV9zaXplPTEwJnBhZ2VfdG9rZW49MjA=",
    "nextPageToken": "cGFnZV9zaXplPTEwJnBhZ2VfdG9rZW49MjA=",
    "total": 100
  },
  "counterparties": [
    { … }
  ]
}