---
title: "Retrieve automations"
url: "https://earlyaccess.developers.bynder.com/apis/automations-api-1/versions/c7c13882-9e51-4554-bcb8-9517eda44741/operations/getApi1AutomationAutomations"
---

> Full API specification: https://earlyaccess.developers.bynder.com/apis/automations-api-1/versions/c7c13882-9e51-4554-bcb8-9517eda44741.md

# Retrieve automations

`GET` `/api/1/automation/automations`

Operation ID: `getApi1AutomationAutomations`

Filter automations by metaproperty actions. Requires a `metaproperty_id`, optionally accepts one or more comma separated `option_ids`.

## Query parameters

- `limit` (integer, int32, optional) - Maximum number of items to return
- `start` (string, optional) - Starting string for pagination
- `actionType` (string, optional) - Filter automations by action type
- `conditionType` (string, optional) - Filter automations by condition type
- `actionsOn` (string, optional) - Filter automations by actions on metaproperty and optionIds. Format: `metapropertyId` or `metapropertyId`;`optionId`,`optionId`. Ensure to add `;` to separate the `metapropertyId` and the `optionId` when using this filter.
- `triggersOn` (string, optional) - Filter automations by triggers on metaproperty and optionIds. Format: `metapropertyId` or `metapropertyId`;`optionId`,`optionId`. Ensure to add `;` to separate the `metapropertyId` and the `optionId` when using this filter.

## Header parameters

- `x-api-correlation-id` (string, optional)

## Responses

- `200`
- `401`
- `404`

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Automations API
  version: "1.0"
servers:
  - url: https://{your-bynder-domain}/
paths:
  /api/1/automation/automations:
    get:
      description: Filter automations by metaproperty actions. Requires a
        `metaproperty_id`, optionally accepts one or more comma separated
        `option_ids`.
      operationId: getApi1AutomationAutomations
      parameters:
        - in: header
          name: x-api-correlation-id
          required: false
          schema:
            type: string
        - description: Maximum number of items to return
          in: query
          name: limit
          required: false
          schema:
            default: 20
            format: int32
            maximum: 1000
            minimum: 1
            type: integer
        - description: Starting string for pagination
          in: query
          name: start
          required: false
          schema:
            type: string
        - description: Filter automations by action type
          in: query
          name: actionType
          required: false
          schema:
            enum:
              - SHOW_OPTION
              - SHOW_METAPROPERTY
              - PREFILL
              - EMPTY
              - SELECT
              - DESELECT
            type: string
        - description: Filter automations by condition type
          in: query
          name: conditionType
          required: false
          schema:
            enum:
              - ALL
              - ANY
              - ANY_OPTION
            type: string
        - description: "Filter automations by actions on metaproperty and optionIds.
            Format: `metapropertyId` or `metapropertyId`;`optionId`,`optionId`.
            Ensure to add `;` to separate the `metapropertyId` and the
            `optionId` when using this filter."
          in: query
          name: actionsOn
          required: false
          schema:
            type: string
        - description: "Filter automations by triggers on metaproperty and optionIds.
            Format: `metapropertyId` or `metapropertyId`;`optionId`,`optionId`.
            Ensure to add `;` to separate the `metapropertyId` and the
            `optionId` when using this filter."
          in: query
          name: triggersOn
          required: false
          schema:
            type: string
      responses:
        "200":
          content:
            application/json:
              examples:
                AutomationsExample:
                  summary: An example of a paginated list of automations
                  value:
                    automations:
                      - actionMetaproperties: Asset Sub-Type
                        actionOptions: Marketing
                        actionType: SHOW_OPTION
                        automationId: 00000000-0000-0000-0000-000000000000
                        conditionType: ANY
                        triggerType: SELECTED
                    metadata:
                      nextPage: /api/1/automation/metaproperties/00000000-0000-0000-0000-000000000000/automations?limit=2&start=00000000-0000-0000-0000-000000000001
              schema:
                properties:
                  automations:
                    items:
                      properties:
                        actionMetaproperties:
                          type: string
                        actionOptions:
                          type: string
                        actionType:
                          enum:
                            - SHOW_OPTION
                            - SHOW_METAPROPERTY
                            - PREFILL
                            - EMPTY
                            - SELECT
                            - DESELECT
                          type: string
                        automationId:
                          type: string
                        conditionType:
                          enum:
                            - ALL
                            - ANY
                            - ANY_OPTION
                          type: string
                        triggerType:
                          enum:
                            - SELECTED
                          type: string
                      required:
                        - automationId
                        - actionType
                        - conditionType
                        - triggerType
                      type: object
                    type: array
                  metadata:
                    properties:
                      nextPage:
                        type: string
                    required:
                      - nextPage
                    type: object
                type: object
          description: ""
        "401":
          content:
            application/json:
              schema:
                properties:
                  errorCode:
                    type: string
                  message:
                    type: string
                required:
                  - errorCode
                  - message
                type: object
          description: ""
        "404":
          content:
            application/json:
              examples:
                MetapropertyNotFoundOutput:
                  summary: Response when metaproperty was not found
                  value:
                    errorCode: metaproperty-not-found
                    message: The metaproperty was not found
              schema:
                properties:
                  errorCode:
                    type: string
                  message:
                    type: string
                required:
                  - errorCode
                  - message
                type: object
          description: ""
      security:
        - httpAuth: []
      summary: Retrieve automations
      tags:
        - Automations - New taxonomy API
security:
  - httpAuth: []
components:
  securitySchemes:
    httpAuth:
      scheme: bearer
      type: http
```