Skip to main content
GET
/
v1
/
async-actions
List Async Actions
curl --request GET \
  --url https://{cluster}.voucherify.io/v1/async-actions \
  --header 'Authorization: Bearer <token>' \
  --header 'X-App-Id: <api-key>' \
  --header 'X-App-Token: <api-key>'
{
  "object": "list",
  "data_ref": "async_actions",
  "async_actions": [
    {
      "id": "aa_0ba518c55290c6fd62",
      "type": "CUSTOMERS.BULK_UPDATE",
      "status": "DONE",
      "created_at": "2022-09-05T11:40:17.098Z",
      "updated_at": "2022-09-05T11:40:17.887Z",
      "request_id": "v-0ba518c52bc99858f0",
      "progress": 100,
      "object": "async_action"
    },
    {
      "id": "aa_0ba50a7ff4d3574568",
      "type": "CUSTOMERS.METADATA_UPDATE",
      "status": "DONE",
      "created_at": "2022-09-05T10:37:56.051Z",
      "updated_at": "2022-09-05T10:37:56.862Z",
      "request_id": "v-0ba50a7feb49984902",
      "progress": 100,
      "object": "async_action"
    }
  ]
}

Authorizations

​
X-App-Id
string
header
required
​
X-App-Token
string
header
required
​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
limit
integer

Limit the number of asynchronous actions that the API returns in the response.

Required range: 1 <= x <= 100
​
end_date
string<date-time>

Limits results to actions scheduled before the end_date. The date format needs to be consistent with ISO 8601 format (2016-11-16T14:14:31Z or 2016-11-16).

Example:

"2023-12-22T10:13:06.487Z"

Response

Returns a list of all scheduled asynchronous actions and detailed information for each scheduled action. Note that a status DONEdoesn't include the result of the completed action. If you need more information about the result, use the ID of the respective async action to call the Get Async Action endpoint.

Response body schema for GET v1/async-actions.

​
object
enum<string>
default:list

The type of the object represented by JSON. This object stores information about asynchronous actions.

Available options:
list
​
data_ref
enum<string>
default:async_actions

Identifies the name of the JSON property that contains the array of asynchronous actions.

Available options:
async_actions
​
async_actions
Async Action Base · object[]
​
has_more
boolean

As query results are always limited by parameters, the has_more flag indicates if there are more records available. This lets you know if you can run another request to get more records returned in the results.

Last modified on September 24, 2025