List pledges

get

https://your-protect-instance.example.com/api/rest/v1/tn/pledges

This endpoint returns a list of pledges directed to/from the Taurus-NETWORK participant linked to the tenant. You can filter the results by specifying the owner or the target of the pledges.

Query Params

ownerParticipantID

string

Get all the pledges where the ownerParticipantID is the owner of the pledge.

targetParticipantID

string

Get all the pledges where the targetParticipantID is the target of the pledge.

sharedAddressIDs

array of strings

Filter pledges by specifying a list of shared address IDs backing the pledges.

sharedAddressIDs

currencyID

string

sortOrder

string

Set this parameter to ASC to get the id sorted in ascending order or DESC to get them in descending order. By default, the order is DESC.

cursor.currentPage

string

Base64-encoded string representing the current window of data

cursor.pageRequest

string

The page to request, w.r.t the current page.
Can be one of FIRST, PREVIOUS, NEXT, LAST

cursor.pageSize

string

The size of the page requested. The handling service should impose a hard limit on this

attributeFiltersJson

string

A JSON representation of a list of AttributeFilter objects. The filters are combined with an attributeFiltersOperator ('OR' by default). Each AttributeFilter can use different comparison operators: = (default if not specified), <> (not equal), > (greater than), >= (greater than or equal), < (less than), <= (less than or equal)

statuses

array of strings

Filter pledges by specifying a list of statuses. Accepted status values: 'CREATED', 'REJECTED_BY_OWNER', 'APPROVED_BY_OWNER', 'RECEIVED', 'REJECTED_BY_TARGET', 'ACCEPTED_BY_TARGET', 'UNPLEDGE_PENDING', 'UNPLEDGE_SENT', 'UNPLEDGE_RECEIVED', 'UNPLEDGED'.

statuses

attributeFiltersOperator

string

Specifies how attribute filters are combined. Accepted values: 'OR' (default), 'AND'.

Responses

200A successful response.

400Bad Request: indicates that the server cannot or will not process the request due to something that is perceived to be a client error (for example, malformed request syntax, invalid request message framing, or deceptive request routing)

401Unauthorized: indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource

403Forbidden: indicates that the server understands the request but refuses to authorize it

404Not Found: indicates that the server cannot find the requested resource

500Internal Server Error: indicates that the server encountered an unexpected condition that prevented it from fulfilling the request

503Service Unavailable: indicates that the server is not ready to handle the request.

defaultAn unexpected error response.