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

# List automations

> The business's comment and story automations (comment a keyword, get a DM), with their counters. Read GET /socials/automations/{id}/logs to see who triggered one and why a DM was skipped.



## OpenAPI

````yaml /developer/api-reference/openapi.json get /socials/automations
openapi: 3.1.1
info:
  title: Crevio API V1
  version: 1.0.0
  description: >
    API for the Crevio creator platform — a multi-tenant SaaS for digital
    product sales.

    Uses snake_case keys following Stripe conventions. All resource IDs are
    string IDs (e.g., "prod_abc123").


    Authentication is a bearer token: `Authorization: Bearer $CREVIO_API_KEY`.

    List endpoints are cursor-paginated with `limit` and `starting_after`.

    Writes accept an `Idempotency-Key` header and are safe to retry.


    Every response carries IETF RateLimit headers (`RateLimit`,
    `RateLimit-Policy`) so a client can

    self-throttle, and `Retry-After` on a 429. The quota is 600 requests per
    minute per credential.


    The API is versioned in the URL path (`/v1`). Nothing is removed without
    in-band warning: a

    deprecated operation is marked `"deprecated": true` here and serves
    `Deprecation` (RFC 9745),

    `Sunset` (RFC 8594) and `Link; rel="deprecation"` headers for at least six
    months before it

    stops answering. See https://crevio.co/docs/developer/guides/versioning.
  contact:
    email: support@crevio.co
    name: Crevio Support
    url: https://crevio.co/docs
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  termsOfService: https://crevio.co/legal/terms-of-service
servers:
  - url: https://api.crevio.co/v1
    description: Production
security:
  - ApiKey: []
tags:
  - name: Account
    description: Current account information
  - name: Bots
    description: >-
      Named bot identities (persona, skills, toolsets) chats and tasks can run
      as
  - name: Analytics
    description: Account-wide business analytics
  - name: BlogCategories
    description: Blog post categories
  - name: BlogPosts
    description: Blog content management
  - name: Broadcasts
    description: One-to-many email sending
  - name: Sequences
    description: Timed email series people move through one step at a time
  - name: CheckoutLinks
    description: Shareable checkout links
  - name: CheckoutConfiguration
    description: Account-wide checkout settings
  - name: Checkouts
    description: Checkout session management
  - name: Contacts
    description: Contact relationship management
  - name: Discounts
    description: Discount code management
  - name: Experiences
    description: Digital experiences (courses, communities, downloads)
  - name: Files
    description: File uploads and external media management
  - name: FormSubmissions
    description: Form submission management
  - name: FormationDocuments
    description: Documents generated for a formation
  - name: Formations
    description: Whitelabel business formation via doola Partner API
  - name: Forms
    description: Hosted forms that capture leads and submissions
  - name: Invoices
    description: Invoice creation, payment, and lifecycle management
  - name: Deals
    description: 'Sales pipeline: opportunities that move from lead to won or lost'
  - name: Activities
    description: >-
      The contact timeline: notes, emails, calls, meetings and deal stage
      changes
  - name: Quotes
    description: >-
      Quotes contacts sign online, which become an invoice or subscription when
      accepted
  - name: LegalPages
    description: Terms, privacy and refund pages for the storefront
  - name: Me
    description: Current user profile
  - name: OrderItems
    description: Order line items
  - name: Orders
    description: Order history and details
  - name: PriceVariants
    description: Product pricing tiers
  - name: Products
    description: Digital product catalog
  - name: Refunds
    description: Refund management
  - name: Reviews
    description: Product reviews
  - name: Socials
    description: Social media management (accounts, posts, media).
  - name: Subscriptions
    description: Subscription lifecycle management (cancel, pause, resume)
  - name: Tags
    description: Contact tags
  - name: TaskRuns
    description: Individual execution records for AI tasks.
  - name: Tasks
    description: >-
      AI tasks — scheduled or event-triggered agentic work (cron, interval,
      once, immediate, event).
  - name: WebhookEndpoints
    description: Webhook endpoint management
  - name: WebhookEvents
    description: Webhook event delivery history
  - name: Leads
    description: Find, verify and enrich business leads (Hunter.io-backed).
  - name: Ads
    description: >-
      Paid advertising — campaigns, ad groups, ads, audiences, targeting, leads,
      conversions, and reports across Meta, Google, TikTok, LinkedIn, Pinterest,
      and X.
  - name: Domains
    description: Custom web domains for your sites.
  - name: Web
    description: >-
      Web search & scraping (search, read, map, crawl, extract, research),
      backed by Firecrawl.
  - name: Skills
    description: >-
      AI skills marketplace — search the catalog and install or uninstall skills
      for your account's agent.
  - name: Schedules
    description: Reusable availability schedules that back event types.
  - name: EventTypes
    x-displayName: Event Types
    description: Bookable services contacts can schedule time on.
  - name: Bookings
    description: Reservations made against event types.
  - name: Waitlist Entries
    description: Buyers waiting for approval on price variants that require it.
  - name: Connections
    description: Third-party app connections (connect, list, execute)
  - name: Approvals
    description: Human-in-the-loop approvals for gated actions
  - name: Logs
    description: Account activity log
  - name: Access
    description: Per-user access checks for gated resources
  - name: ApiKeys
    description: API key management
  - name: Audio
    description: AI audio generation
  - name: Calls
    description: Outbound phone calls placed by the account's agent
  - name: Chapters
    description: Course chapters
  - name: Deployments
    description: Site deployments and build logs
  - name: Email
    description: Inboxes, threads, messages, drafts and delivery events
  - name: Email Suppressions
    description: Addresses no send path will deliver to
  - name: EventSessions
    description: Scheduled sessions of an event experience
  - name: EventSources
    description: Third-party event sources that trigger tasks
  - name: Events
    description: Events an account can subscribe to
  - name: ForumPosts
    description: Posts inside a forum experience
  - name: Images
    description: AI image generation, editing and stock search
  - name: Jobs
    description: Long-running asynchronous jobs
  - name: Lessons
    description: Lessons inside a course chapter
  - name: LinkItems
    description: Links inside a link-in-bio experience
  - name: Phone Consents
    description: Recorded consent to place calls to a number
  - name: Phone Numbers
    description: Phone numbers provisioned for the account
  - name: Phone Suppressions
    description: Do-not-call entries
  - name: Phone Blocks
    description: Callers the account's phone lines refuse
  - name: Sites
    description: AI-built sites — storefronts and web apps
  - name: Status
    description: API and account status
  - name: Topics
    description: Discussion topics inside a forum experience
  - name: Plans
    description: The plans Crevio sells, their credit tiers, prices and limits.
  - name: Usage
    description: Credit usage and transaction history
  - name: Users
    description: Users of the account
  - name: Video
    description: AI video generation
  - name: Secrets
    description: Account-level environment variables shared across the account's sites
  - name: Billing Portal
    description: Hosted billing pages for your contacts
  - name: Data
    description: >-
      Included business data: search the tool catalog, then run a tool
      (website/SEO, people, companies, local businesses, social, e-commerce,
      finance, jobs, reviews, ads, real estate, news, apps, travel, weather,
      legal).
  - name: Chats
    description: Delegate work to the Crevio agent and read its replies
  - name: ScriptRuns
    description: Run JavaScript on the account's computer, without an agent turn
  - name: Artifacts
    description: Download files that runs and scripts produced
  - name: Pages
    description: Self-contained HTML pages hosted at a stable link
  - name: Team
    description: Members, roles, credit limits and invitations
  - name: Allowed Senders
    description: Who the agent's inbox answers
  - name: SMS messages
    description: Texts on business phone lines.
  - name: SMS follow-ups
    description: >-
      Texting new leads and past contacts until they answer. The email
      counterpart is Sequences.
  - name: Feedback
    description: Tell the Crevio team about a bug or a missing feature.
externalDocs:
  description: Crevio developer documentation
  url: https://crevio.co/docs/developer
paths:
  /socials/automations:
    get:
      tags:
        - Socials
      summary: List automations
      description: >-
        The business's comment and story automations (comment a keyword, get a
        DM), with their counters. Read GET /socials/automations/{id}/logs to see
        who triggered one and why a DM was skipped.
      operationId: listSocialAutomations
      parameters:
        - name: platform
          in: query
          required: false
          description: Only automations on this platform.
          schema:
            type: string
        - name: account_id
          in: query
          required: false
          description: Only automations on this connected account (sacct_ prefix id).
          schema:
            type: string
      responses:
        '200':
          description: Automations
          content:
            application/json:
              schema:
                type: object
                properties:
                  object:
                    type: string
                    enum:
                      - list
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        object:
                          type: string
                          enum:
                            - social_automation
                        platform:
                          type: string
                          enum:
                            - instagram
                            - facebook
                            - tiktok
                            - threads
                            - linkedin
                            - youtube
                        account_id:
                          type: string
                          description: Connected account it runs on (sacct_ prefix id).
                        name:
                          type: string
                          description: Shown to the business in the Automations page.
                        trigger:
                          type: string
                          enum:
                            - comment
                            - live_comment
                            - story_reply
                            - story_mention
                          description: >-
                            `comment` (default): a comment on a post.
                            `story_reply`: a reply to a story. `story_mention`:
                            a story that mentions the account; send `keywords:
                            []`. Every trigger but `comment` is Instagram only.
                        keywords:
                          type: array
                          items:
                            type: string
                          description: >-
                            Words that fire it. An empty list fires on every
                            comment.
                        match_mode:
                          type: string
                          enum:
                            - word
                            - contains
                            - exact
                          description: >-
                            `word` matches the keyword as a whole word,
                            `contains` anywhere ("app" fires on "happy"),
                            `exact` only when the whole comment is the keyword.
                            Defaults to `contains`; prefer `word`.
                        exclude_keywords:
                          type: array
                          items:
                            type: string
                          description: Comments containing any of these never fire it.
                        dm_message:
                          type: string
                          description: >-
                            The private DM. Required on Instagram and Facebook;
                            rejected on TikTok, Threads, LinkedIn and YouTube,
                            which have no private reply. `{{first_name}}`,
                            `{{name}}` and `{{username}}` are filled in. 640
                            characters at most when buttons are set.
                        buttons:
                          type: array
                          maxItems: 3
                          items:
                            type: object
                            properties:
                              title:
                                type: string
                                maxLength: 20
                                description: Button label, 20 characters at most.
                              url:
                                type: string
                                description: >-
                                  Link the button opens. Clicks are counted in
                                  stats.link_clicks.
                            required:
                              - title
                              - url
                          description: >-
                            Up to 3 link buttons under the DM. Send [] to remove
                            them. Instagram may refuse buttons in a first DM to
                            someone who does not follow the account, which
                            spends that comment's one private reply: for cold
                            audiences send plain text and the link after they
                            answer.
                        comment_reply:
                          type: string
                          description: >-
                            Public reply under the comment, e.g. "Sent you a
                            DM!". Required on TikTok, Threads, LinkedIn and
                            YouTube, where it is the only action.
                        public_reply_policy:
                          type: string
                          enum:
                            - after_dm
                            - always
                          description: >-
                            `after_dm` posts the public reply only once the DM
                            went out.
                        also_match_in_dms:
                          type: boolean
                          description: >-
                            Also answer a DM that contains a keyword. Needs at
                            least one keyword. Use it for a printed QR code or
                            sign: "scan, then send MENU".
                        dm_delay_seconds:
                          type: integer
                          description: Wait this long before sending the DM, up to 86400.
                        audience:
                          type: object
                          description: Who gets the DM. Instagram only.
                          properties:
                            follower_status:
                              type: string
                              enum:
                                - any
                                - follower
                                - non_follower
                              description: '`follower` makes it a followers-only reward.'
                            when_unknown:
                              type: string
                              enum:
                                - send
                                - skip
                                - verify
                              description: >-
                                Instagram only says whether someone follows the
                                account once they have messaged it. `verify`
                                sends a one-tap "I'm following" check first and
                                delivers the DM after the tap; use it with
                                `follower`.
                        follow_gate:
                          type: object
                          description: >-
                            The one-tap follow check sent when
                            audience.when_unknown is `verify`.
                          properties:
                            message:
                              type: string
                              description: Asks them to follow, then tap the button.
                            button_label:
                              type: string
                              description: Label of the tap button, e.g. "I'm following".
                            not_following_message:
                              type: string
                              description: Sent when they tap but still do not follow.
                        repeat_policy:
                          type: object
                          description: >-
                            How often one person can trigger it. Defaults to
                            once per person, ever.
                          properties:
                            mode:
                              type: string
                              enum:
                                - once
                                - every_comment
                            cooldown_hours:
                              type: integer
                              description: >-
                                With `every_comment`: hours before the same
                                person can trigger it again.
                        platform_post_id:
                          type:
                            - string
                            - 'null'
                          description: >-
                            Only fire on this live post: the post's `id` from
                            GET /socials/comments. Omit for every post; send
                            null to unbind.
                        post_id:
                          type:
                            - string
                            - 'null'
                          description: >-
                            Only fire on this scheduled or published Crevio post
                            (spost_ prefix id); it arms itself when the post
                            goes live. Send null to unbind.
                        post_title:
                          type:
                            - string
                            - 'null'
                          description: Snippet of the bound post, for display.
                        active:
                          type: boolean
                          description: false pauses it.
                        stats:
                          type:
                            - object
                            - 'null'
                          additionalProperties: true
                          description: >-
                            Counters: triggered, dms_sent, dms_failed,
                            unique_contacts, link_clicks, unique_clicks,
                            audience_skipped, follow_gate_sent,
                            follow_gate_passed.
                        created_at:
                          type: string
                          format: date-time
                      required:
                        - id
                        - object
                        - platform
                        - account_id
                        - active
                  has_more:
                    type: boolean
                  url:
                    type: string
                required:
                  - object
                  - data
                  - has_more
                  - url
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          $ref: '#/components/responses/UnprocessableEntity'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          $ref: '#/components/responses/InternalServerError'
      security:
        - ApiKey: []
      x-codeSamples:
        - lang: typescript
          label: Typescript (SDK)
          source: |-
            import { Crevio } from "@crevio/sdk";

            const crevio = new Crevio({
              apiKey: process.env["CREVIO_API_KEY"] ?? "",
            });

            async function run() {
              const result = await crevio.socials.listAutomations();

              console.log(result);
            }

            run();
components:
  responses:
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: invalid_request_error
              code: authentication_required
              message: You did not provide an API key.
      headers:
        RateLimit:
          $ref: '#/components/headers/RateLimit'
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimitPolicy'
        Request-Id:
          $ref: '#/components/headers/RequestId'
        Deprecation:
          $ref: '#/components/headers/Deprecation'
        Sunset:
          $ref: '#/components/headers/Sunset'
        Link:
          $ref: '#/components/headers/DeprecationLink'
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: invalid_request_error
              code: forbidden
              message: You do not have permission to perform this action
      headers:
        RateLimit:
          $ref: '#/components/headers/RateLimit'
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimitPolicy'
        Request-Id:
          $ref: '#/components/headers/RequestId'
        Deprecation:
          $ref: '#/components/headers/Deprecation'
        Sunset:
          $ref: '#/components/headers/Sunset'
        Link:
          $ref: '#/components/headers/DeprecationLink'
    UnprocessableEntity:
      description: Validation error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: validation_error
              code: validation_failed
              message: Email is required
              errors:
                email:
                  - can't be blank
      headers:
        RateLimit:
          $ref: '#/components/headers/RateLimit'
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimitPolicy'
        Request-Id:
          $ref: '#/components/headers/RequestId'
        Deprecation:
          $ref: '#/components/headers/Deprecation'
        Sunset:
          $ref: '#/components/headers/Sunset'
        Link:
          $ref: '#/components/headers/DeprecationLink'
    TooManyRequests:
      description: >-
        Rate limit exceeded — 600 requests per minute per owner on the free
        tier: every API key and OAuth token one person holds on an account
        shares one budget, and the account's team keys share another. Retry
        after the number of seconds in `Retry-After`.
      headers:
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
        RateLimit:
          $ref: '#/components/headers/RateLimit'
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimitPolicy'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: invalid_request_error
              code: rate_limit_exceeded
              message: Too many requests. Please retry later.
    InternalServerError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              type: api_error
              code: internal_error
              message: An unexpected error occurred
      headers:
        RateLimit:
          $ref: '#/components/headers/RateLimit'
        RateLimit-Policy:
          $ref: '#/components/headers/RateLimitPolicy'
        Request-Id:
          $ref: '#/components/headers/RequestId'
        Deprecation:
          $ref: '#/components/headers/Deprecation'
        Sunset:
          $ref: '#/components/headers/Sunset'
        Link:
          $ref: '#/components/headers/DeprecationLink'
  schemas:
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
              enum:
                - api_error
                - invalid_request_error
                - validation_error
                - idempotency_error
            code:
              type: string
            message:
              type: string
            param:
              type: string
            errors:
              type: object
            doc_url:
              type: string
          required:
            - type
            - message
      required:
        - error
  headers:
    RateLimit:
      description: >-
        Remaining quota for the current window, as an IETF structured field:
        `"default";r=<remaining>;t=<seconds until reset>`.
      schema:
        type: string
        examples:
          - '"default";r=596;t=11'
    RateLimitPolicy:
      description: >-
        The quota this credential is subject to:
        `"default";q=<requests>;w=<window seconds>`.
      schema:
        type: string
        examples:
          - '"default";q=600;w=60'
    RequestId:
      description: Unique id for this request. Quote it when reporting a problem.
      schema:
        type: string
        examples:
          - 8fe045fe-cb8a-4407-a44d-5df60385e522
    Deprecation:
      description: >-
        Present only on a deprecated operation. Structured-field date (RFC 9745)
        — `@` followed by the Unix timestamp at which the operation became
        deprecated.
      schema:
        type: string
        examples:
          - '@1775001600'
    Sunset:
      description: >-
        Present only on a deprecated operation. HTTP-date (RFC 8594) after which
        the operation stops responding. Always at least six months after
        `Deprecation`.
      schema:
        type: string
        examples:
          - Thu, 01 Oct 2026 00:00:00 GMT
    DeprecationLink:
      description: >-
        Present only on a deprecated operation. `<url>; rel="deprecation"`
        pointing at the migration notes.
      schema:
        type: string
        examples:
          - >-
            <https://crevio.co/docs/developer/guides/versioning>;
            rel="deprecation"
    RetryAfter:
      description: Seconds to wait before retrying.
      schema:
        type: integer
        examples:
          - 11
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: Authorization
      description: 'API key in the format: Bearer {api_token}'

````

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