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

# Search automations

> Search saved automations with pagination and sorting.

**Filters**: `keywords` (name substring), `is_enabled`, `is_archived` (defaults to false), `trigger_type`.

**Sorting**: `sort_by` — `created_at` (default), `updated_at`, `name`. `sort_order` — `asc` or `desc` (default).

List rows include action counts, not the full trigger or action payloads. Use `GET /v1/automations/{id}` for the full recipe.



## OpenAPI

````yaml /api-reference/openapi-v1.json post /v1/automations/search
openapi: 3.1.0
info:
  title: Stardex API (v1)
  version: 1.0.0
  description: >-
    Stardex ATS API — manage candidates, jobs, companies, and recruiting
    workflows.
servers:
  - url: https://api.stardex.ai
    description: Production API server
security:
  - bearerAuth: []
tags:
  - name: Persons
    description: Manage person records — contacts, work history, and custom fields.
  - name: Jobs
    description: Manage job postings — pipeline stages, team members, and custom fields.
  - name: Candidates
    description: Manage candidate records and pipeline stage transitions.
  - name: Companies
    description: Browse and retrieve company records.
  - name: Lists
    description: Create, search, and retrieve saved person and company lists.
  - name: Person Activities
    description: Create and manage activity records (notes, emails, meetings) for persons.
  - name: Team Members
    description: List team members for use in search filters and assignments.
  - name: Custom Fields
    description: Retrieve custom field definitions and tag options for search filters.
paths:
  /v1/automations/search:
    post:
      tags:
        - Automations
      summary: Search automations
      description: >-
        Search saved automations with pagination and sorting.


        **Filters**: `keywords` (name substring), `is_enabled`, `is_archived`
        (defaults to false), `trigger_type`.


        **Sorting**: `sort_by` — `created_at` (default), `updated_at`, `name`.
        `sort_order` — `asc` or `desc` (default).


        List rows include action counts, not the full trigger or action
        payloads. Use `GET /v1/automations/{id}` for the full recipe.
      operationId: searchAutomations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AutomationsSearchBody'
      responses:
        '200':
          description: Automations found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomationsSearchResponse'
              example:
                success: true
                data:
                  - id: aaa11111-bbbb-cccc-dddd-eeeeeeee2222
                    name: Email owner when a candidate is rejected
                    is_enabled: true
                    is_archived: false
                    runs_on_api_changes: false
                    trigger_type: candidate_status_changed
                    action_count: 6
                    action_types:
                      - send_email
                      - delay
                      - add_note
                      - agent_instructions
                      - create_task
                    created_at: '2026-08-21T10:00:00Z'
                    updated_at: '2026-08-21T10:00:00Z'
                meta:
                  total: 12
                  offset: 0
                  limit: 100
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                    description: Always false for error responses.
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: >-
                          Machine-readable error code (e.g. "VALIDATION_ERROR",
                          "NOT_FOUND").
                      message:
                        type: string
                        description: Human-readable error description.
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                    description: Always false for error responses.
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: >-
                          Machine-readable error code (e.g. "VALIDATION_ERROR",
                          "NOT_FOUND").
                      message:
                        type: string
                        description: Human-readable error description.
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    enum:
                      - false
                    description: Always false for error responses.
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        description: >-
                          Machine-readable error code (e.g. "VALIDATION_ERROR",
                          "NOT_FOUND").
                      message:
                        type: string
                        description: Human-readable error description.
                    required:
                      - code
                      - message
                required:
                  - success
                  - error
components:
  schemas:
    AutomationsSearchBody:
      type: object
      properties:
        offset:
          type:
            - integer
            - 'null'
          minimum: 0
          default: 0
          description: Records to skip for pagination. Defaults to 0.
        limit:
          type: integer
          minimum: 1
          maximum: 100
          default: 100
          description: Max records per page (1–100). Defaults to 100.
        keywords:
          type: array
          items:
            type: string
          description: Case-insensitive substring match on the automation name.
        is_enabled:
          type: boolean
          description: Filter by whether the automation is enabled.
        is_archived:
          type: boolean
          default: false
          description: >-
            Filter by archive status. Defaults to false so archived automations
            are hidden.
        trigger_type:
          type: string
          enum:
            - schedule
            - candidate_status_changed
            - job_status_changed
            - job_created
            - deal_status_changed
          description: Filter by trigger kind.
        sort_by:
          type: string
          enum:
            - created_at
            - updated_at
            - name
          default: created_at
          description: Column to sort by. Defaults to created_at.
        sort_order:
          type: string
          enum:
            - asc
            - desc
          default: desc
          description: Sort direction. Defaults to desc.
    AutomationsSearchResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - true
        data:
          type: array
          items:
            $ref: '#/components/schemas/AutomationSummary'
        meta:
          type: object
          properties:
            total:
              type: number
              description: Total matching records across all pages.
            offset:
              type: number
              description: Current pagination offset.
            limit:
              type: number
              description: Page size used for this request.
          required:
            - total
            - offset
            - limit
      required:
        - success
        - data
        - meta
    AutomationSummary:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Automation UUID.
        name:
          type: string
          description: Display name.
        is_enabled:
          type: boolean
          description: Whether new fires are enqueued.
        is_archived:
          type: boolean
          description: Whether the automation is archived.
        runs_on_api_changes:
          type: boolean
          description: >-
            When true, changes made through the API or MCP (including Zapier)
            also start this automation. Off by default, because one API call can
            change hundreds of records and each change starts a run.
        trigger_type:
          type: string
          enum:
            - schedule
            - candidate_status_changed
            - job_status_changed
            - job_created
            - deal_status_changed
          description: Trigger kind.
        action_count:
          type: integer
          description: Number of actions on this automation.
        action_types:
          type: array
          items:
            type: string
            enum:
              - send_email
              - add_note
              - agent_instructions
              - delay
              - create_task
          description: Distinct action types, in position order.
        created_at:
          type: string
          description: ISO 8601 creation timestamp.
        updated_at:
          type: string
          description: ISO 8601 last-updated timestamp.
      required:
        - id
        - name
        - is_enabled
        - is_archived
        - runs_on_api_changes
        - trigger_type
        - action_count
        - action_types
        - created_at
        - updated_at
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Authenticate with a Bearer token: API key, OAuth token, or session
        token.

````

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