Automations

Get list of automations

Get list of automations

get/workspaces/{workspace_id}/projects/{project_id}/automations

Request

  • Base URL: https://app.mammoth.io/api/v2
  • URL: https://app.mammoth.io/api/v2/workspaces/{workspace_id}/projects/{project_id}/automations
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-KEY and API key in header X-API-SECRET and API key in header X-WORKSPACE-ID

Path parameters

workspace_idinteger required

Workspace refers to a collection of projects. Workspace ID is unique identifier for workspace.

Example:4
project_idinteger required

Project ID of the workspace

Example:4

Query parameters

fieldsstring nullable

Fields to be returned in a comma-separated format may include id, name, status_info, created_at.

Example:id,name
idstring

Track multiple automation ids, comma separated

Example:1,2,3
namestring nullable

Track multiple automation names, comma separated

Example:automation_name1,automation_name2,automation_name3
statusstring nullable

Track multiple automation statuses, comma separated

Example:processing,action_needed
created_atstring nullable

Track multiple automations, which falls under created_at date range

Example:(from:'2023-12-19T09:39:17.628Z',to:'2023-12-26T09:42:43.152Z')
updated_atstring nullable

Track multiple automations, which falls under updated_at date range

Example:(from:'2023-12-19T09:39:17.628Z',to:'2023-12-26T09:42:43.152Z')
limitinteger

Max number of result to return

Example:10
offsetinteger

Distance from the beginning of the list of results

Example:10
sortstring nullable

Sort the automations based on the fields

Example:(id:asc),(name:asc)
task_typestring nullable

Filter automations by task type. When omitted, retention policy automations are excluded by default.

Example:apply_retention_policy
dataset_idinteger nullable

Filter automations whose task details reference this dataset ID. Must be used together with task_type.

Example:42

Response

List automations

limitinteger
offsetinteger
nextstring required

Example response

{
  "automations": [
    {
      "tasks": [
        {
          "details": [
            {
              "last_run_result": {
                "summary": "Sample last run result",
                "value": {
                  "failure_reason": {
                    "error_code": "4AUTO14",
                    "error_message": "schema mismatch"
                  }
                }
              },
              "recipients": [
                {
                  "summary": "Sample recipients",
                  "value": [
                    ""
                  ]
                }
              ]
            }
          ],
          "conditions": [
            {
              "details": {
                "summary": "Sample task details",
                "value": {
                  "frequency": "monthly",
                  "interval": 1,
                  "start_at": "2025-08-16 10:56:20Z",
                  "until": "2025-09-22 10:56:20Z",
                  "by_week_day": [
                    "mo"
                  ],
                  "by_month_day": [
                    1,
                    2
                  ],
                  "start_now": true
                }
              }
            }
          ]
        }
      ],
      "conditions": [
        {
          "details": {
            "summary": "Sample task details",
            "value": {
              "frequency": "monthly",
              "interval": 1,
              "start_at": "2025-08-16 10:56:20Z",
              "until": "2025-09-22 10:56:20Z",
              "by_week_day": [
                "mo"
              ],
              "by_month_day": [
                1,
                2
              ],
              "start_now": true
            }
          }
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 3 revisions of this API.