Skip to main content
GET
/
automations
/
{id}
Get automation by ID
curl --request GET \
  --url https://app.drippi.ai/api/v1/automations/{id} \
  --header 'x-api-key: <api-key>'
{
  "status": "success",
  "automation": {
    "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 a specific automation by its ID. Use this endpoint to retrieve detailed information about a particular automation campaign.

Authorizations

​
x-api-key
string
header
required

API key for authentication

Path Parameters

​
id
string
required

Automation ID

Response

Successfully retrieved automation

​
status
string
Example:

"success"

​
automation
object