Automation Studio

GET Retrieve a list of all automations in the account.

GET /automation/v1/automations

Operation ID: getAutomations.

Required Scopes

To retrieve the automations in your account, your API user must have this permission:

  • Automation | Automations | Read (automations_read)

Parameters

  • Authorization (header, string, required) A unique, time-limited token that you can use to issue requests to the Marketing Cloud Engagement API. Replace YOUR_ACCESS_TOKEN with your authentication token.

    Example

    Bearer YOUR_ACCESS_TOKEN
  • $page (query, integer) The page of results to retrieve. Each page includes the number of records specified by the $pagesize parameter. You can retrieve additional pages by incrementing this number in subsequent calls.
    Default: 1.
  • $pagesize (query, integer) The number of records to return on each page of results.
    Default: 25.
  • $filter (query, string) A string that describes the filter to apply to the response. The filter must be URL encoded. Use single quotes for field values. Filters can include the eq and neq operators.
  • $orderBy (query, string) The field and sort method to use to sort the results, such as $orderBy=memberID ASC to sort the results in ascending order by the value of the memberID field.
  • view (query, string) Defines the type of extra data to return. The only accepted value is targetdes. If you specify this parameter, the response includes automations that have target data extensions.

Responses

  • 200 Indicates that the request to retrieve all automations was successful.

    Media type: application/json. Schema: getAllAutomationsResponseBody.

    Example

    {
      "page": 1,
      "pageSize": 25,
      "count": 3,
      "items": [
        {
          "id": "471671be-09b1-4bed-a661-3f0c8561646f",
          "name": "Scheduled Automation",
          "description": "",
          "key": "Test123",
          "typeId": 1,
          "type": "scheduled",
          "statusId": 3,
          "status": "Running",
          "categoryId": 1157180,
          "lastRunTime": "2025-06-19T10:37:30.323",
          "lastRunInstanceId": "8ec9be34-ef49-42b4-95d4-daabc893592b",
          "schedule": {
            "scheduleStatus": "none"
          }
        },
        {
          "id": "3ec3bec9-2eb5-4023-b49e-1ff51817ac01",
          "name": "File Drop Automation",
          "description": "",
          "key": "77158f0c-bdd1-eaf4-62f6-5281d63d608f",
          "typeId": 2,
          "type": "triggered",
          "statusId": 8,
          "status": "InactiveTrigger",
          "categoryId": 1157180,
          "fileTrigger": {
            "queueFiles": false,
            "isPublished": false,
            "fileNamePatternTypeId": 1,
            "fileNamingPattern": "footer",
            "folderLocationText": "triggered_automations\\",
            "triggerActive": false
          }
        },
        {
          "id": "8eabb77c-1f7f-41e5-9f64-120009babcfe",
          "name": "Triggered Automation",
          "description": "",
          "key": "f24d848b-b77b-4b63-bed2-a573523166fc",
          "typeId": 2,
          "type": "triggered",
          "statusId": 8,
          "status": "InactiveTrigger",
          "categoryId": 1157180,
          "automationTrigger": {
            "queueFiles": true,
            "filenamePattern": "example.csv",
            "filenamePatternTypeId": 4,
            "fileTransferLocationId": "e039f099-5e14-454e-a369-689e309f7699",
            "sampleFileName": "example.csv",
            "status": 1
          }
        }
      ]
    }
  • 401 Indicates that the API wasn’t able to authorize your request. When you receive a 401 response, verify that you obtained an authorization token and that the token is still valid.

    Media type: application/json. Schema: httpErrorResponseBody.

    Example

    {
      "documentation": "https://developer.salesforce.com/docs/atlas.en-us.mc-apis.meta/mc-apis/error-handling.htm",
      "errorcode": 0,
      "message": "Not Authorized"
    }
  • 403 This response indicates that the API accepted your request but couldn’t authorize it. When you receive a 403 response, make sure you have the necessary permission scope for the operation. You can modify permission scopes on the Installed Apps page in Marketing Cloud Engagement Setup.

    Media type: application/json. Schema: mceErrorResponseBody.

    Example

    {
      "message": "Insufficient Privileges to complete this action.",
      "errorcode": 20002,
      "documentation": ""
    }
  • 500 Indicates that the API encountered an error when processing the request. When you receive a 500 response, verify that the request uses the correct syntax.

    Media type: application/json. Schema: httpErrorResponseBody.

    Example

    {
      "documentation": "https://developer.salesforce.com/docs/atlas.en-us.mc-apis.meta/mc-apis/error-handling.htm",
      "errorcode": 0,
      "message": "Internal Server Error"
    }