Batches

List batches

Changed on

List all batches created by the authenticated user within their organization.

Results are automatically filtered by the authenticated user's ID. Users can only view their own batches, not batches created by other users in the organization.

Results are sorted by creation date (most recent first) and include pagination metadata.

get/batches

Request

  • Base URL: https://run-workflow.adobe.io
  • URL: https://run-workflow.adobe.io/batches
  • Auth: HTTP bearer and API key in header x-api-key

Query parameters

status'pending' | 'running' | 'completed' | 'failed' | 'cancelled'

Filter by batch status.

workflowIdstring

Filter by workflow ID.

createdAfterstring date-time

Filter by creation date (ISO 8601 format).

createdBeforestring date-time

Filter by creation date (ISO 8601 format).

limitinteger

Maximum number of results per page (default 50, max 100).

offsetinteger

Pagination offset (default 0).

Headers

api-version'1.0'

Public API contract version for batch operations (/batch/…, GET /batches). The supported value is 1.0. If omitted, the service assumes 1.0. Unsupported values return 400 with status: "error".

x-gw-ims-org-idstring required

IMS organization ID for the authenticated caller. Scopes every request to that organization.

x-gw-ims-user-idstring required

IMS user ID for the authenticated caller.

Response

Success

orgIdstring required

IMS organization ID for the authenticated caller.

Example response

{
  "orgId": "A1B2C3D4567890ABCDEFFEDA51@AdobeOrg",
  "pagination": {
    "limit": 50,
    "count": 3
  }
}

Changes

  • db6f373f16f0Revision changes
    • breaking

      added the new required header request parameter x-gw-ims-org-id

    • breaking

      added the new required header request parameter x-gw-ims-user-id

    • info

      the endpoint scheme security BearerAuth AND ApiKeyAuth was added to the API

    • info

      the endpoint scheme security BearerAuth was removed from the API

    • info

      the response property became required for the status

  • 995d308ddc56Revision changes
    • breaking

      the response property // became nullable for the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      added the new batch enum value to the // response property for the response status

    • warning

      added the new error enum value to the response property for the response status

    • warning

      added the new error enum value to the response property for the response status

    • warning

      added the new error enum value to the response property for the response status

    • info

      the endpoint scheme security BearerAuth was added to the API

    • info

      api tag Batches added

    • info

      added the new optional header request parameter api-version

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

      the response property / became required for the status

    • info

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

    • info

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