List all Automations

Retrieve a paginated list of automations for a project with filtering options


List all Automations

Automations in Blue allow you to create powerful workflows that trigger actions based on specific events. This endpoint retrieves all automations configured for your project, including their triggers, actions, and current status.

Basic Example

query ListAutomations {
  automationList {
    items {
      id
      isActive
      trigger {
        type
        color
      }
      actions {
        type
        color
      }
      createdAt
    }
    pageInfo {
      totalItems
      hasNextPage
    }
  }
}

Advanced Example

query ListAutomationsAdvanced {
  automationList(
    filter: {
      customFieldIds: ["field_123", "field_456"]
    }
    skip: 0
    take: 50
  ) {
    items {
      id
      isActive
      createdAt
      updatedAt
      
      # Trigger details
      trigger {
        id
        type
        color
        metadata {
          ... on AutomationTriggerMetadataTodoOverdue {
            incompleteOnly
          }
        }
        customField {
          id
          name
          type
        }
        customFieldOptions {
          id
          title
          color
        }
        todoList {
          id
          title
        }
        tags {
          id
          title
          color
        }
        assignees {
          id
          name
          email
        }
      }
      
      # Action details
      actions {
        id
        type
        color
        duedIn
        assigneeTriggerer
        
        # Action-specific fields
        customField {
          id
          name
        }
        customFieldOptions {
          id
          title
        }
        todoList {
          id
          title
        }
        tags {
          id
          title
        }
        assignees {
          id
          name
        }
        
        # Email action metadata
        metadata {
          ... on AutomationActionMetadataSendEmail {
            email {
              subject
              to
              from
              content
            }
          }
          ... on AutomationActionMetadataCreateChecklist {
            checklists {
              title
              checklistItems {
                title
                duedIn
              }
            }
          }
        }
      }
      
      # Creator info
      createdBy {
        id
        name
        email
      }
    }
    
    pageInfo {
      totalItems
      totalPages
      hasNextPage
      hasPreviousPage
    }
    
    totalCount
  }
}

Input Parameters

AutomationFilterInput

ParameterTypeRequiredDescription
customFieldIds[String]NoFilter automations related to specific custom fields

Pagination Parameters

ParameterTypeRequiredDescription
skipIntNoNumber of items to skip (default: 0)
takeIntNoNumber of items to return (default: 20)

Response Fields

AutomationPagination

FieldTypeDescription
items[Automation!]!List of automation objects
pageInfoPageInfo!Pagination information
totalCountInt!Total number of automations

Automation

FieldTypeDescription
idID!Unique identifier
triggerAutomationTrigger!The event that triggers this automation
actions[AutomationAction!]!Actions performed when triggered
isActiveBoolean!Whether the automation is currently active
createdByUser!User who created the automation
projectProject!Project this automation belongs to
createdAtDateTime!Creation timestamp
updatedAtDateTime!Last update timestamp

AutomationTrigger

FieldTypeDescription
idID!Unique identifier
typeAutomationTriggerType!Type of trigger event
colorStringAssociated color (hex format)
metadataAutomationTriggerMetadataTrigger-specific configuration
customFieldCustomFieldRelated custom field (if applicable)
customFieldOptions[CustomFieldOption!]Selected options for select fields
todos[CustomFieldReferenceTodo!]Referenced todos
todoListTodoListRelated todo list
tags[Tag!]Related tags
assignees[User!]Related assignees

AutomationAction

FieldTypeDescription
idID!Unique identifier
typeAutomationActionType!Type of action to perform
colorStringAssociated color (hex format)
duedInIntDays to add for due date actions
assigneeTriggererStringSpecial assignee identifier
metadataAutomationActionMetadataAction-specific configuration
customFieldCustomFieldTarget custom field
customFieldOptions[CustomFieldOption!]Options for select fields
todoListTodoListTarget todo list
tags[Tag!]Tags to add/remove
assignees[User!]Assignees to add/remove
httpOptionAutomationActionHttpOptionHTTP request configuration

Trigger Types

TypeDescription
TODO_CREATEDWhen a new record is created
TODO_LIST_CHANGEDWhen a record moves between lists
TODO_MARKED_AS_COMPLETEWhen a record is completed
TODO_MARKED_AS_INCOMPLETEWhen a record is uncompleted
ASSIGNEE_ADDEDWhen an assignee is added
ASSIGNEE_REMOVEDWhen an assignee is removed
DUE_DATE_CHANGEDWhen due date is modified
DUE_DATE_REMOVEDWhen due date is cleared
DUE_DATE_EXPIREDWhen due date passes
TAG_ADDEDWhen a tag is added
TAG_REMOVEDWhen a tag is removed
CHECKLIST_ITEM_MARKED_AS_DONEWhen checklist item is completed
CHECKLIST_ITEM_MARKED_AS_UNDONEWhen checklist item is uncompleted
TODO_COPIED_OR_MOVED_FROM_OTHER_PROJECTWhen record is imported
CUSTOM_FIELD_ADDEDWhen custom field value is set
CUSTOM_FIELD_REMOVEDWhen custom field value is cleared
CUSTOM_FIELD_BUTTON_CLICKEDWhen button field is clicked
COLOR_ADDEDWhen color is applied
COLOR_REMOVEDWhen color is removed

Action Types

TypeDescription
CHANGE_TODO_LISTMove record to different list
MARK_AS_COMPLETEComplete the record
MARK_AS_INCOMPLETEUncomplete the record
ADD_ASSIGNEEAdd assignee(s)
REMOVE_ASSIGNEERemove assignee(s)
ADD_ASSIGNEE_TRIGGERERAdd user who triggered automation
CHANGE_DUE_DATESet or update due date
REMOVE_DUE_DATEClear due date
ADD_TAGApply tag(s)
REMOVE_TAGRemove tag(s)
ADD_COLORApply color
REMOVE_COLORRemove color
ADD_CUSTOM_FIELDSet custom field value
REMOVE_CUSTOM_FIELDClear custom field value
CREATE_CHECKLISTCreate new checklist
MARK_CHECKLIST_ITEM_AS_DONEComplete checklist items
MARK_CHECKLIST_ITEM_AS_UNDONEUncomplete checklist items
COPY_TODODuplicate the record
SEND_EMAILSend email notification
GENERATE_PDFGenerate PDF document
MAKE_HTTP_REQUESTCall external API

Required Permissions

Listing automations requires authentication and project access:

RoleCan List Automations
OWNER✅ Yes
ADMIN✅ Yes
MEMBER✅ Yes
CLIENT✅ Yes

All authenticated users with project access can view automations.

Error Responses

Authentication Required

{
  "errors": [{
    "message": "You must be logged in",
    "extensions": {
      "code": "UNAUTHENTICATED"
    }
  }]
}

Project Not Found

{
  "errors": [{
    "message": "Project not found",
    "extensions": {
      "code": "PROJECT_NOT_FOUND"
    }
  }]
}

Important Notes

  • Ordering: Automations are always returned newest first (by creation date)
  • Project Scope: Automations are scoped to the current project context
  • Active Status: Check isActive to determine if an automation is currently running
  • Metadata: Some triggers and actions have additional metadata for configuration
  • Performance: Use pagination for projects with many automations
  • Filtering: Currently only supports filtering by custom field IDs