BatchAction

SPA: Retrieves a list of batch actions

Returns a paginated list of batch actions for the authenticated user's client.

GET/api/spa/batch-actions

SPA: Retrieves a list of batch actions

curl --request GET \
  --url 'https://app.output.rocks/api/spa/batch-actions?page=1' \
  --header 'X-AUTH-TOKEN: <api-key>'

200

application/json

[
  {
    "id": 123,
    "type": "retry_blocked",
    "entityClass": "<string>",
    "done": true,
    "doneAt": "2024-08-23T00:00:00+00:00",
    "createdAt": "2024-08-23T00:00:00+00:00",
    "updatedAt": "2024-08-23T00:00:00+00:00",
    "subClientId": 3,
    "subClientDescription": "Branch Office A"
  }
]

Authorizations

X-AUTH-TOKEN

stringheaderrequired

Value for the X-AUTH-TOKEN header parameter.

Query Parameters

page

integerdefault:1

The collection page number

pagination

boolean

Enable or disable pagination

Response

200application/json

BatchAction collection

integer

type

enum<string>

Available options: retry_blockedforce_rendering_restart_pausedrendering_restart_pausedforce_rendering_revalidate_invalidedrendering_revalidate_invalidedmark_email_bouncedmark_email_deliveredresend_emaildelete

entityClass

string

done

boolean

Available options: truefalse

doneAt

string<date-time> | null

createdAt

string<date-time>

UTC date time of entry creation

Example: "2024-08-23T00:00:00+00:00"

updatedAt

string<date-time>

UTC date time of last entry update

Example: "2024-08-23T00:00:00+00:00"

subClientId

integer

SubClient ID. Provided on instances with enabled sub-client module only.

Example: 3

subClientDescription

string

SubClient description. Provided on instances with enabled sub-client module only.

Example: "Branch Office A"