Batch

List batches

List your organization's batches.

get/batches

Query parameters

afterstring

A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

limitinteger

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 20.

Response

Batch listed successfully.

first_idstring
last_idstring
has_moreboolean required
object'list' required

Example response

{
  "first_id": "batch_abc123",
  "last_id": "batch_abc456"
}

Changes

Changed in 2 of the 163 revisions of this API.35

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

  • 74cbcf73838f32See the full diff
    • ▲

      response property data/items/errors/data/items/line list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property data/items/errors/data/items/param list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      response property data/items/metadata list-of-types was widened by adding types null to media type application/json of response 200

      response-property-list-of-types-widened

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    This revision also has 40 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog