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

# List automations

> Every automation in the workspace with its status, trigger, keywords and the post it
is attached to, newest first.

Needs a `read` or `full` key.




## OpenAPI

````yaml get /automations
openapi: 3.1.0
info:
  title: inDM API
  version: 1.0.0
  summary: >-
    Build, launch and read Instagram comment-to-DM automations from your own
    code.
  description: >
    The inDM API gives your code the same reach as the inDM app: list the posts
    and reels

    inDM has synced, pull in new ones, build automations on them, set them live
    and read

    how they are doing.


    Every request is authenticated with an API key created in **Settings → API
    keys**.

    Keys belong to one workspace and carry a scope, `read` or `full`. Keys are
    server-side

    secrets: the API sends no CORS headers, so a browser can't call it directly.


    Nothing sends through this API. No DM, broadcast or public reply leaves
    Instagram by

    this path, and every automation it creates starts as a `draft`. Setting one
    `live` is

    the only call that changes what people on Instagram receive.
  contact:
    name: inDM support
    email: support@indm.social
    url: https://docs.indm.social
servers:
  - url: https://api.indm.social/v1
    description: Production
security:
  - apiKey: []
tags:
  - name: Workspace
    description: The workspace and API key behind a request.
  - name: Accounts
    description: Connected Instagram accounts, their health, and content refreshes.
  - name: Media
    description: Posts and reels inDM has synced from Instagram.
  - name: Automations
    description: Comment-to-DM automations. Created as drafts; set live when you're ready.
paths:
  /automations:
    get:
      tags:
        - Automations
      summary: List automations
      description: >
        Every automation in the workspace with its status, trigger, keywords and
        the post it

        is attached to, newest first.


        Needs a `read` or `full` key.
      operationId: listAutomations
      parameters:
        - name: account_id
          in: query
          required: false
          description: Only this account's automations.
          schema:
            type: string
            format: uuid
        - name: status
          in: query
          required: false
          description: Only automations with this status.
          schema:
            type: string
            enum:
              - draft
              - live
              - paused
        - $ref: '#/components/parameters/Limit'
        - $ref: '#/components/parameters/Cursor'
      responses:
        '200':
          description: One page of automations, newest first.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/X-Request-Id'
            RateLimit-Limit:
              $ref: '#/components/headers/RateLimit-Limit'
            RateLimit-Remaining:
              $ref: '#/components/headers/RateLimit-Remaining'
            RateLimit-Reset:
              $ref: '#/components/headers/RateLimit-Reset'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomationList'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/ServerError'
components:
  parameters:
    Limit:
      name: limit
      in: query
      required: false
      description: How many items per page. From 1 to 100.
      schema:
        type: integer
        minimum: 1
        maximum: 100
        default: 20
    Cursor:
      name: cursor
      in: query
      required: false
      description: >
        The `next_cursor` from the previous page. Leave it out for the first
        page. Cursors

        are opaque; pass them back exactly as you received them.
      schema:
        type: string
  headers:
    X-Request-Id:
      description: >-
        A unique id for this request. Include it when you write to support and
        we can find the request at once.
      schema:
        type: string
      example: req_8Qm2ZcY4vN7tLp1K
    RateLimit-Limit:
      description: >-
        Requests this key may make per minute, across every route. Sent once the
        key is accepted.
      schema:
        type: integer
      example: 120
    RateLimit-Remaining:
      description: >-
        Requests left in the current one-minute window. `0` when a write is
        refused for the write limit.
      schema:
        type: integer
      example: 117
    RateLimit-Reset:
      description: Seconds until the current window resets.
      schema:
        type: integer
      example: 42
    Retry-After:
      description: Seconds to wait before trying again.
      schema:
        type: integer
      example: 18
  schemas:
    AutomationList:
      allOf:
        - type: object
          required:
            - data
          properties:
            data:
              type: array
              items:
                $ref: '#/components/schemas/AutomationSummary'
        - $ref: '#/components/schemas/ListMeta'
    AutomationSummary:
      type: object
      description: An automation as it appears in a list.
      required:
        - id
        - name
        - status
        - trigger
        - binding
        - account_id
        - keywords
        - dm_sent_count
        - created_at
        - updated_at
      properties:
        id:
          type: string
          format: uuid
          example: 9a4b1c7e-2d3f-4a5b-8c6d-1e2f3a4b5c6d
        name:
          type: string
          example: Spring guide reel
        status:
          type: string
          enum:
            - draft
            - live
            - paused
          example: live
        trigger:
          type: string
          description: What fires it, such as `comment`.
          example: comment
        binding:
          type: string
          description: >
            How it is attached to content: `specific` for one post, `next` for
            the next post

            the account publishes, `any` for every post.
          example: specific
        account_id:
          type: string
          format: uuid
          example: 6f1c2a9e-3b7d-4e21-9a55-0c8d2f4b7e10
        media_id:
          type: string
          format: uuid
          description: The post it is attached to. Present when `binding` is `specific`.
          example: 3d2a7f10-9c4e-4b8a-a1f2-6e0b5d7c9a31
        keywords:
          type: array
          description: The words that trigger it, as stored.
          items:
            type: string
          example:
            - GUIDE
        dm_sent_count:
          type: integer
          description: DMs this automation has sent since it was created.
          example: 182
        created_at:
          type: string
          format: date-time
          example: '2026-11-05T09:02:11Z'
        updated_at:
          type: string
          format: date-time
          example: '2026-11-05T09:04:30Z'
    ListMeta:
      type: object
      required:
        - has_more
      properties:
        has_more:
          type: boolean
          description: True when there is at least one more page.
        next_cursor:
          type: string
          description: >-
            Pass this as `cursor` to get the next page. Present only when
            `has_more` is true.
    Error:
      type: object
      description: Every error has this shape.
      required:
        - error
      properties:
        error:
          type: object
          required:
            - type
            - code
            - message
            - doc_url
          properties:
            type:
              type: string
              description: The family of error. Each maps to one HTTP status.
              enum:
                - invalid_request
                - authentication_error
                - permission_error
                - plan_limit
                - not_found
                - conflict
                - rate_limited
                - api_error
            code:
              type: string
              description: >
                A stable, specific code. Branch on this, never on `message`.
                Every code is

                listed on [Errors](/errors).
              example: dm_message_too_long
            message:
              type: string
              description: >-
                A sentence for a person, saying what happened and what to do
                next. It may change; don't parse it.
            param:
              type: string
              description: >-
                The request field the error is about. Left out when no single
                field is.
              example: dm_message
            doc_url:
              type: string
              format: uri
              description: A link to this code on the [Errors](/errors) page.
              example: https://docs.indm.social/errors#dm_message_too_long
  responses:
    BadRequest:
      description: >-
        The request can't be processed as sent. `param` names the field when
        there is one.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: invalid_request
              code: button_label_too_long
              message: >-
                The button label is 26 characters. Instagram shows up to 20, so
                it would be cut off.
              param: button_label
              doc_url: https://docs.indm.social/errors#button_label_too_long
    Unauthorized:
      description: The API key is missing, malformed, expired or revoked.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: authentication_error
              code: api_key_expired
              message: >-
                This API key expired on 3 Feb 2027. Create a new one under
                Settings → API keys.
              doc_url: https://docs.indm.social/errors#api_key_expired
    NotFound:
      description: Nothing with that id exists in this key's workspace.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: not_found
              code: media_not_found
              message: >-
                There's no post with that id in this workspace. GET /v1/media
                lists them; refresh the account first if it was just published.
              param: media_id
              doc_url: https://docs.indm.social/errors#media_not_found
    RateLimited:
      description: >-
        This key went past its rate limit. Wait for `Retry-After` seconds, then
        try again.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
        Retry-After:
          $ref: '#/components/headers/Retry-After'
        RateLimit-Limit:
          $ref: '#/components/headers/RateLimit-Limit'
        RateLimit-Remaining:
          $ref: '#/components/headers/RateLimit-Remaining'
        RateLimit-Reset:
          $ref: '#/components/headers/RateLimit-Reset'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: rate_limited
              code: rate_limited
              message: >-
                That's more than 120 requests a minute on one key. Wait 18s and
                try again.
              doc_url: https://docs.indm.social/errors#rate_limited
    ServerError:
      description: >
        Something failed on our side. Retrying with backoff is safe for reads.
        The same body

        comes with `503` when inDM briefly can't reach its database.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/X-Request-Id'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: api_error
              code: internal_error
              message: >-
                Something went wrong on our end. Try again; if it keeps
                happening, quote request req_8Qm2ZcY4vN7tLp1K to
                support@indm.social.
              doc_url: https://docs.indm.social/errors#internal_error
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      bearerFormat: indm_ API key
      description: >
        An API key from **Settings → API keys** in the inDM app, sent as

        `Authorization: Bearer indm_...`. Keys belong to one workspace and carry
        a scope:

        `read` for GET routes and the validate dry run, `full` for everything.
        Keep keys on

        your server; never ship one to a browser or a mobile app.

````

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