API Reference

List all batches

get
https://api.fire.com/business/v1/batches

This endpoint will return a list of batches with the specified types and statuses. You will need to enable PERM_BUSINESS_GET_BATCHES to use this endpoint.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum

The type of the batch. Can be one of the listed enums.

Allowed:
string
enum

You can order the batches by date. No other options at this time

Allowed:
string
enum

You can order the batches by ascending or descending order.

Allowed:
int64

The page offset. Defaults to 0. This is the record number that the returned list will start at. E.g. offset = 40 and limit = 20 will return records 40 to 59.

int64

The number of records to return. Defaults to 10 - max is 200.

Responses

Updated 8 months ago

Language
Credentials
Bearer
API Access Token
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago