Automations

List automations

Changed on

Returns the comment-to-DM automations of the workspace, newest first. An automation answers a keyword in a comment (or a DM, or an Instagram story reply) with a DM, once per person. It runs on the connected Instagram account, the connected Facebook Page or the connected X account (platform; on X it answers DMs only). Needs the opt-in automations:read scope.

get/automations

Request

  • Base URL
    https://api.omnisocials.com/v1
  • URL
    https://api.omnisocials.com/v1/automations
  • Auth
    HTTP bearer

Query parameters

status'active' | 'paused' | 'completed'
post_idstring

Only the automations bound to this OmniSocials post (one per platform at most).

platform'instagram' | 'facebook' | 'x'

Only the automations of this platform.

Response

List of automations

Example response

{
  "data": [
    {
      "id": "318",
      "name": "Guide DM",
      "post_id": "1024",
      "instagram_media_id": "17912345678901234",
      "facebook_post_id": "104857600123456_987654321098765",
      "trigger": {
        "keywords": [
          "guide"
        ]
      },
      "actions": {
        "dm": {
          "text": "Here is the guide: https://example.com/guide"
        },
        "public_reply": {
          "enabled": true,
          "variations": [
            "Sent you a DM!"
          ]
        }
      },
      "limits": {
        "max_sends": 500,
        "stop_at": "2026-11-30T23:00:00.000Z"
      },
      "stats": {
        "matched": 120,
        "sent": 112,
        "skipped": 6,
        "failed": 2,
        "last_event_at": "2026-10-21T15:00:12.000Z"
      },
      "created_at": "2026-10-20T14:32:10.000Z",
      "updated_at": "2026-10-20T14:35:42.000Z"
    }
  ]
}

Changes

    • warning

      added the new x enum value to the // response property for the response status

    • info

      added the new enum value x to the query request parameter platform

    • warning

      added the new facebook enum value to the // response property for the response status

    • info

      added the new optional query request parameter platform

    • info

      added the optional property // to the response with the status