Skip to main content
GET
/
automations
Get automations
curl --request GET \
  --url https://app.drippi.ai/api/v1/automations \
  --header 'x-api-key: <api-key>'
{
  "status": "success",
  "automations": [
    {
      "id": "<string>",
      "sourceId": "<string>",
      "uid": "<string>",
      "name": "<string>",
      "automationType": "<string>",
      "status": "<string>",
      "testMode": true,
      "automationVersion": 123,
      "sendingAccount": "<string>",
      "startTime": {
        "_seconds": 123,
        "_nanoseconds": 123
      },
      "sentMessages": 123,
      "skippedMessages": 123,
      "respondedMessages": 123,
      "failedMessages": 123,
      "creditUsage": 123,
      "newMessagesActive": true,
      "followupsActive": true,
      "followups": {},
      "messageConfig": {
        "settings": {
          "tweetContext": {
            "mode": "<string>",
            "enabled": true
          },
          "websiteContext": {
            "mode": "<string>",
            "enabled": true
          },
          "splitMessages": true,
          "maxLength": 123
        },
        "temperature": 123,
        "context": "<string>",
        "model": "<string>",
        "generatorVersion": "<string>",
        "script": "<string>",
        "scriptText": "<string>",
        "messagePurpose": {},
        "messageElements": {},
        "messageTone": {},
        "backgroundInfo": {
          "jobTitle": "<string>",
          "name": "<string>",
          "productName": "<string>",
          "productDescription": "<string>",
          "productCategory": "<string>"
        }
      },
      "automationSettings": {
        "autoRetweet": {
          "enabled": true,
          "params": {}
        },
        "blacklistCheck": {
          "enabled": true,
          "params": {}
        },
        "activityCheck": {
          "enabled": true,
          "params": {
            "includeOnUnknown": true,
            "minDaysSinceLastActivity": 123
          }
        },
        "AICheck": {
          "enabled": true,
          "params": {
            "includeOnUnknown": true,
            "locationCheck": {
              "type": "<string>",
              "enabled": true,
              "params": {
                "countryCodes": [
                  "<string>"
                ],
                "minGdpPerCapita": 123
              }
            },
            "languageCheck": {
              "type": "<string>",
              "enabled": true,
              "params": {
                "languageCodes": [
                  "<string>"
                ]
              }
            }
          }
        },
        "previousConversationsCheck": {
          "enabled": true,
          "params": {}
        },
        "autoFollow": {
          "enabled": true,
          "params": {}
        },
        "autoLike": {
          "enabled": true,
          "params": {}
        },
        "previouslyContactedCheck": {
          "enabled": true,
          "params": {}
        }
      },
      "scheduleV1": {
        "scheduleType": "<string>",
        "timezone": {
          "name": "<string>",
          "id": "<string>"
        },
        "messages": "<string>",
        "timezoneModified": true,
        "hasAdvancedSchedule": true,
        "advancedSchedule": {}
      }
    }
  ]
}
Returns all automations for the authenticated user within a specified time period. You can filter results by providing from and to query parameters in ISO 8601 format.

Authorizations

​
x-api-key
string
header
required

API key for authentication

Query Parameters

​
from
string<date-time>

Start date (ISO 8601 format)

​
to
string<date-time>

End date (ISO 8601 format)

Response

Successfully retrieved automations

​
status
string
Example:

"success"

​
automations
object[]