> ## Documentation Index
> Fetch the complete documentation index at: https://apidocs.neetoform.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List automation rules

> List the automation rules of a form, in the order they run. The list does not include events, conditions or actions. Use Show an automation rule to get them.

> [!NOTE]
>
> Replace `{your-subdomain}` with your workspace’s subdomain. \
> Learn how to find your subdomain in [Workspace subdomain](https://apidocs.neetoform.com/api/workspace-subdomain.md).


## OpenAPI

````yaml bundled/automation-rules.yaml GET /forms/{form_id}/automation_rules
openapi: 3.0.3
info:
  title: NeetoForm APIs
  version: 2.0.0
servers:
  - description: NeetoForm APIs
    url: https://{your-subdomain}.neetoform.com/api/external/v2
    variables:
      your-subdomain:
        default: spinkart
        description: >-
          Replace **spinkart** with your [workspace's
          subdomain](/api/workspace-subdomain).
security: []
paths:
  /forms/{form_id}/automation_rules:
    get:
      tags:
        - Automation Rules
      summary: List automation rules
      description: >-
        List the automation rules of a form, in the order they run. The list
        does not include events, conditions or actions. Use Show an automation
        rule to get them.
      parameters:
        - $ref: '#/components/parameters/api_key_header'
        - $ref: '#/components/parameters/form_id_param'
        - $ref: '#/components/parameters/search_param'
        - $ref: '#/components/parameters/page_number_param'
        - $ref: '#/components/parameters/page_size_param'
      responses:
        '200':
          description: OK - Request succeeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/automation_rules_response'
        '404':
          description: Not Found - The form does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error_response'
              example:
                error: Form does not exist.
components:
  parameters:
    api_key_header:
      in: header
      name: X-Api-Key
      description: >-
        Use the X-Api-Key header to provide your workspace API key. Refer to
        [Authentication](/api/authentication) for more information.
      required: true
      schema:
        type: string
        default: your-api-key
    form_id_param:
      in: path
      name: form_id
      description: >-
        Unique ID of the form. Refer to [Getting the Form
        ID](/api/getting-form-id) for detailed instructions.
      required: true
      schema:
        type: string
    search_param:
      in: query
      name: search
      description: >-
        Only return rules whose name, description or condition field matches
        this text.
      required: false
      schema:
        type: string
    page_number_param:
      in: query
      name: page_number
      description: >-
        Page of results to retrieve, starting from 1. Defaults to 1 when
        omitted.
      required: false
      schema:
        type: integer
    page_size_param:
      in: query
      name: page_size
      description: Number of results per page. Defaults to 30 when omitted.
      required: false
      schema:
        type: integer
  schemas:
    automation_rules_response:
      type: object
      properties:
        automation_rules:
          type: array
          items:
            $ref: '#/components/schemas/automation_rule_summary'
        pagination:
          $ref: '#/components/schemas/pagination'
    error_response:
      type: object
      properties:
        error:
          type: string
    automation_rule_summary:
      type: object
      properties:
        id:
          type: string
          example: 0d4a5b8e-2f61-4b0c-8a3e-5f7c9e2d1a44
        name:
          type: string
          example: Email the sales team
        description:
          type: string
          nullable: true
          example: New leads
        status:
          type: string
          enum:
            - enabled
            - disabled
        performer:
          type: string
          description: '`any`, or the name of an organization role.'
          example: any
        display_order:
          type: integer
          description: Position in the order in which rules run, starting from 1.
        disabled_reason:
          type: string
          nullable: true
        execution_delay:
          $ref: '#/components/schemas/execution_delay'
        created_at:
          $ref: '#/components/schemas/date_time_field'
        updated_at:
          $ref: '#/components/schemas/date_time_field'
    pagination:
      type: object
      properties:
        total_records:
          type: integer
        total_pages:
          type: integer
        current_page_number:
          type: integer
        page_size:
          type: integer
    execution_delay:
      type: object
      nullable: true
      description: How long to wait after the event before the actions run.
      properties:
        value:
          type: integer
          minimum: 1
          maximum: 15
          example: 5
        unit:
          type: string
          enum:
            - minutes
            - hours
            - days
          example: minutes
    date_time_field:
      type: string
      format: date-time

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.