Sign in

v1

latestOpenAPI 3.1.02026-07-261520561.4 KB
Book Transfer

List Book Transfers

get/book

Query parameters

from_account_idstring

ID of the account originating the transfer. Filterable.

org_idstring

ID of the organization with which the object is associated. Filterable.

statusstring

One of pending, canceled, sent, or error. Filterable.

to_account_idstring

ID of the account receiving the transfer. Filterable.

page_cursorstring

Pagination cursor, value is the object ID.

page_sizeinteger

Limits the number of objects in the returned list, value must be a number greater than or equal to 1. Defaults to 100.

from_datestring

Lists the objects created on the date provided and onwards. Date must be in ISO 8601 format (“YYYY-MM-DD”).

to_datestring

Lists the objects created before the date provided. Date must be in ISO 8601 format (“YYYY-MM-DD”).

Response

A dictionary with a data property that contains a list of up to page_size book elements, starting after the book described by page_cursor. If no more books are available, the resulting list will be empty.