Gateway

List batches

Lists owned async batch jobs for the authenticated workspace from the gateway's persisted async job store.

get/batches

Request

  • Base URL: https://api.phaseo.app/v1
  • URL: https://api.phaseo.app/v1/batches
  • Auth: HTTP bearer

Query parameters

limitinteger

Maximum number of batch jobs to return. Defaults to 20 and caps at 100.

statusstring[]

Batch lifecycle status filter. Repeat the parameter, use a comma-separated status value, or use statuses for comma-separated filters.

statusesstring

Comma-separated lifecycle status filters.

offsetinteger

Number of batch jobs to skip before returning the page.

Response

Batch list response

objectstring
first_idstring nullable
last_idstring nullable
has_moreboolean

Example response

{
  "object": "list",
  "data": [
    {
      "webhook": {
        "delivery": {
          "delivered_event_types": [
            "video.completed"
          ]
        },
        "attempts": [
          {
            "delivery_key": "video.completed",
            "event_type": "video.completed"
          }
        ]
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.