Skip to navigation
Taurus NetworkTaurus Network - Pledge

List 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.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

ownerParticipantIDstringOptional
Get all the pledges where the ownerParticipantID is the owner of the pledge.
targetParticipantIDstringOptional
Get all the pledges where the targetParticipantID is the target of the pledge.
sharedAddressIDslist of stringsOptional
Filter pledges by specifying a list of shared address IDs backing the pledges.
currencyIDstringOptional
sortOrderstringOptional
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.currentPagestringOptional

Base64-encoded string representing the current window of data

cursor.pageRequeststringOptional

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

cursor.pageSizestringOptionalformat: "uint64"
The size of the page requested. The handling service should impose a hard limit on this
attributeFiltersJsonstringOptional

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)

statuseslist of stringsOptional

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'.

attributeFiltersOperatorstringOptional

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

Response

A successful response.
pledgeslist of objectsOptional
cursorobjectOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
500
Internal Server Error
503
Service Unavailable Error