# List Alerts

Returns a paginated list of all alerts configured for your account, including their current is_fired status.
Alerts can be of type Quantity (triggered by stock level) or DateReminder (triggered by a datetime custom field value).

Endpoint: GET /api/v1/alerts
Security: BearerAuth

## Query parameters:

  - `per_page` (number)
    Page size | Defaults to 10
    Example: "2"

  - `page` (number)
    Page number | Defaults to 1
    Example: "1"

## Response 200 fields (application/json):

  - `data` (array)

  - `data.id` (number)
    Alert ID, assigned on creation.

  - `data.item_id` (number, required)
    The item the alert watches. Required on create and on every update, whatever the alert's type. Leave it out and the request is rejected with 422.
    Example: 12345

  - `data.custom_attribute_id` (number,null)
    For a DateReminder, the datetime custom field to watch. Pairs with item_id: together they identify whose field value the alert is about.

  - `data.type` (string, required)
    Quantity fires when an item's stock crosses a threshold. DateReminder fires relative to a date held in a datetime custom field.
    Enum: "Quantity", "DateReminder"

  - `data.threshold_method` (string)
    What triggers the alert. Use a quantity_* method (or less_than_or_equal_to_min_quantity) with type: Quantity, and before, after or same_day with type: DateReminder.
    Enum: "less_than_or_equal_to_min_quantity", "quantity_greater_than", "quantity_less_than", "quantity_less_than_equal_to", "quantity_greater_than_equal_to", "before", "after", "same_day"

  - `data.threshold_value` (number)
    The number the alert is compared against.
    Example: 5

  - `data.threshold_interval` (string,null)
    How far before or after the date to fire. Required for DateReminder alerts, null for Quantity.
    Enum: "days", "weeks", "months", "years", null

  - `data.recipient_groups` (array)
    Who gets notified when the alert fires. Defaults to owners if omitted.
    Enum: "owners", "admins", "members"

  - `data.triggerable_type` (string)
    What the alert watches, derived by Sortly from item_id and custom_attribute_id. Read-only: sending it is rejected.
    Enum: "Node", "CustomAttributeValue"

  - `data.triggerable_id` (number)
    ID of the item or custom field the alert resolves to, derived by Sortly. Read-only: sending it is rejected.
    Example: 12345

  - `data.is_deleted` (boolean)
    Whether the alert has been deleted.

  - `data.is_fired` (boolean)
    Whether this alert has already notified its recipients.

  - `meta` (object)

  - `meta.page` (number)

  - `meta.next_page_url` (string,null)

  - `meta.total_pages` (number)

  - `meta.total_count` (number)

## Response 400 fields (application/json):

  - `message` (string)

## Response 401 fields (application/json):

  - `message` (string)

## Response 429 fields (application/json):

  - `message` (string)