API Reference

Get all transfers

Log in to see full request history
Path Params
string
required
Query Params
string
length ≤ 400
ids
array of uuids
ids
int32
states
array of strings
states
types
array of strings
types
countries
array of strings
countries
boolean
string
length ≤ 700

Comma separated list of fields

int32
1 to 2147483647

Pagination index (1 based, page 1 = 1, page 2 = 2...)

int32
1 to 9999

Size of the result page (default: 20, max 500)

int32

The number of items to skip (if not provided, it will use the default page and size prop)

string
length ≤ 100

The field to sort

boolean

True to sort ascending

string
length ≤ 3000

A serialized as json filter string using the JsonRuleEngine.net format
https://github.com/antoinebidault/JsonRuleEngine.Net
The filters is a query param, that's why he must be properly serialized as a json string and url encoded
e.g. {"field":"ProcessingType", "operator":"notEqual", "value": "Done"}
The field prop must match one property name of the object (present in the output results)
The operator can be equal,
notEqual,
lessThan,
lessThanInclusive,
greaterThan,
greaterThanInclusive,
in,
notIn,
contains,
doesNotContains,
isNull,
isNotNull,
isEmpty
You can combine the filters as following :
{ "separator":"Or","rules": [{"field":"ProcessingType", "operator":"notEqual", "value": "Done"},{"field":"ProcessingType", "operator":"isNull"}]}
Serialize the filter param as following:
?filters=${uriEncodeComponent(JSON.stringify({"field":"ProcessingType", "operator":"notEqual", "value": "Done"}))}

boolean
Response

Language
Credentials
Click Try It! to start a request and see the response here!