API Reference
GuidesReleasesPostmanRecipesAPI Reference

List transfers for an entity

get
https://api.eu1.notabene.id/entities//tx

Retrieves a paginated list of transfers for the specified entity. Supports filtering by status, asset, direction, date range, and more.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
^did:([a-z0-9]+):((?:(?:[a-zA-Z0-9._-]|(?:%[0-9a-fA-F]{2}))*:)*(?:[a-zA-Z0-9._-]|(?:%[0-9a-fA-F]{2}))+)((;[a-zA-Z0-9_.:%-]+=[a-zA-Z0-9_.:%-]*)*)(/[^#?]*)?([?][^#]*)?(#.*)?$

The DID of the entity

Query Params
integer
1 to 100
Defaults to 25

Maximum number of transfers to return

integer
≥ 0
Defaults to 0

Number of transfers to skip

agent
array of objects

Filter transfers by agent DIDs

agent
status
array of objects

Filter transfers by status

status
asset
array of objects

Filter transfers by asset identifier

asset
party
array of strings

Filter transfers by party identifiers

party
refs
array of strings

Filter transfers by reference identifiers

refs
date-time
length ≥ 1
^\d{4}-\d{2}-\d{2}

Filter transfers created before this date (ISO 8601)

date-time
length ≥ 1
^\d{4}-\d{2}-\d{2}

Filter transfers created after this date (ISO 8601)

string

Comma-separated list of fields to include in the response.

string
enum

Filter transfers by direction

Allowed:
string

Search term for full-text search

string

Field to sort by

string
enum

Sort order (asc or desc)

Allowed:
boolean

Filter to transfers requiring action

boolean

Filter to transfers with pending information requests

const
enum
Allowed:
Responses

Updated 5 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago

Did this page help you?