Search Unissued Transfer Document

post

https://sandbox.portal.block.aero/api/v2/td/search

Searches unissued Transfer Documents (Not Ready, Ready, and Pending Signature) within your organization using the provided search criteria. Supports filtering, sorting, and pagination.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

index

int32

Starting index of the first record to return. Default: 0.

count

int32

1 to 1000

Defaults to 100

Maximum number of records to return. Default: 100. Maximum: 1,000.

Body Params

Searching and sorting terms to filter the data

A recursive expression to build search query filters. Supporting comparison operators, single or
multiple values, sort instructions, and logical composition.

sort

array of objects | null

Array of sort conditions to apply to the results. Can only be present in the root search expression, not in nested "and" or "or" expressions.

sort

key

string | null

Name of the field to search against. Use dot notation for nested fields. Refer to the response schema for supported searchable fields. Must be used together with "value" or "values". Cannot be used with "and" or "or".

value

string | null

Value to match against the field specified by "key", using the selected operator. Use "type" when the value is not a string. Must be used together with "key". Cannot be used with "values", "and", or "or".

values

array of strings | null

Array of values to match against the field specified by "key". Use with the in or nin operators. When "values" is provided, "value" is ignored. Use "type" when the values are not strings. Cannot be used with "value", "and", or "or".

values

type

string | null

Data type of the search value. Use when "value" or "values" contains non-string data. Supported values: numeric, uuid, bool, datetime. Cannot be used with "and" or "or".

operator

string | null

Comparison operator for the search condition. Supported values: eq (equals), ne / neq (not equals), gt (greater than), gte (greater than or equal), lt (less than), lte (less than or equal), like (contains substring), nlike (does not contain substring),
in (value in list), nin (value not in list), null (field is null), notnull (field is not null), notempty (field is not empty string), nullorempty (field is null or empty string), notnullandempty (field is not null and not empty string),
property_eq (matches a nested BlockaeroAssetProperty value), property_neq (does not match a nested BlockaeroAssetProperty value). Cannot be used with "and" or "or"."

and

array of objects | null

Array of search expressions combined using logical AND. All expressions must be satisfied for a record to be returned. Each element follows the same search expression schema. Cannot be used with "key", "value", "values", "type", "operator", or "or".

and

array of objects | null

Array of search expressions combined using logical OR. At least one expression must be satisfied for a record to be returned. Each element follows the same search expression schema. Cannot be used with "key", "value", "values", "type", "operator", or "and".

Headers

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Response

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK