Get batches

This endpoint retrieves batches and their corresponding statuses of the batch operations of the account of the calling user.

Method	Path	Operation*
GET	/batches	get_batches

*

In order for a user to perform the "get_batches" operation, the "get_batches" permission must be included in the list of allowed actions in the statement of the user's role.

Request

Parameter	Type	In	Description
cursor optional	string	query string	Position of the cursor denoting the start of the list of batches to be returned.
ge optional **	timestamp	query string	Returns batches where creation time is greater than or equal to the given Unix(opens new window) timestamp.
le optional **	timestamp	query string	Returns batches where creation time is lower than or equal to the given Unix(opens new window) timestamp.
limit optional **	integer, DEFAULT=1000	query string	Limit on the number of batches to be returned. The default and maximum value is 1000.

*

The "cursor" parameter is optional and does not need to be included in the query string of the request. If it is not included in the request, its default value is used.

**

The ge, le, and limit parameters are optional and do not need to be included in the request. If they are not included in the request, their default values are used. If the number of the records to be returned exceeds the limit provided in the request:

• if the ge parameter is provided, the records to be returned are counted starting from the timestamp provided.
• if the le parameter is provided, the records to be returned are counted from the timestamp provided.
• if both ge and le parameters are provided, the records to be returned are counted from the timestamp provided in the le parameter (i.e., the most recent records are returned).

Response

Attribute	Type	Description
batches	dictionary	Key-value pairs: - key: Batch UUID. - value: Status of the batch.

Status codes

Requests to this endpoint result in generic status codes. For a comprehensive list of status codes, please consult the Status codes section.