---
title: "Get list of actions"
method: GET
path: "/v1/action"
tags: ["action"]
---

# Get list of actions

`GET /v1/action`

## Request

- Base URL: `https://rule-engine-api.frisbii.com`
- URL: `https://rule-engine-api.frisbii.com/v1/action`
- Auth: HTTP basic

## Query parameters

- `from` string: Time range from (inclusive). Local date and time (according to account timezone) on the form `yyyy-MM-dd`, `yyyyMMdd`, `yyyy-MM-ddTHH:mm`, `yyyy-MM-ddTHH:mm:ss` or `yyyy-MM-ddTHH:mm:ss.SSS`. Default from if no `interval` is given depends on the query. If the query limits on relation e.g. customer and/or subscription, the default from will be epoch 1970-01-01, otherwise one month before `to`
- `to` string: Time range to (exclusive). Local date and time (according to account timezone) on the form `yyyy-MM-dd`, `yyyyMMdd`, `yyyy-MM-ddTHH:mm`, `yyyy-MM-ddTHH:mm:ss` or `yyyy-MM-ddTHH:mm:ss.SSS`. Defaults to now.
- `interval` string: Limit from `to` and interval back in time. E.g. one week. Will take precedence over `from`. Defined in ISO 8601 duration. See https://en.wikipedia.org/wiki/ISO_8601#Durations
- `size` integer: Page size between 10 and 100 (default 20)
- `next_page_token` string: Next page token from previous response to get next page
- `id` string: ID of the action
- `entity_id` string: ID of the entity that the actions is associated with
- `type` string: Type of the action
- `state` string: Type of the action

## Response `200`

Successful operation

- ActionListResponseDto: List result with actions
  - `size` integer, required: Page size used in paginated list
  - `count` integer, required: Number of elements in current page. If less than page size it is the last page.
  - `to` string, required: Local date and time range used as to (exclusive)
  - `from` string, required: Local date and time range used as from (inclusive)
  - `content` ResponseActionDto[], required: List of actions for current page
    - `id` string: Action id
    - `state` 'new' | 'success' | 'failure' | 'retrying' | 'nothing_to_do': State of the action
    - `created` string, date-time: Action created timestamp
    - `details` ResponseActionDetailsDto: Action details
      - `type` string
    - `action` string, required: Action type
    - `schedule` ScheduleDto, required: Scheduling settings for the action
      - `execution_date` string, date-time: Execution time of the action. You must provide either an event type or an execution date.
      - `event_type` string: Event type which triggers the action. You must provide either an event type or an execution date.
    - `entity_id` string: The ID (handle) of the product on which the action is performed.
    - `entity_type` string: Type of the entity on which the action is performed.
    - `additional_actions` ResponseActionDto[]: List of additional actions that will be executed
  - `next_page_token` string: Pagination token to use to get the next page. Notice that page size and range should be the same for all page requests. If not present the last page has been reached.

## Other responses

- `400`: Invalid request, see error codes at https://api.reepay.com/v1/error_codes
- `401`: None or invalid credentials provided in access to secured resource
- `403`: Not authorized to perform resource operation
- `404`: Resource or referenced resource not found, see error codes at https://api.reepay.com/v1/error_codes
- `429`: Request limiting exceeded, request rate or concurrent requests, see error code 122 and 123
- `500`: Internal service error, error is reported automatically to Frisbii

---

[API](https://skmtc.dev/frisbii/apis/frisbii-rule-engine-api.md) - [All operations](https://skmtc.dev/frisbii/apis/frisbii-rule-engine-api/llms.txt) - [OpenAPI document](https://skmtc.dev/frisbii/apis/frisbii-rule-engine-api/revisions/62a992b1a09d?raw)