> ## Documentation Index > Fetch the complete documentation index at: https://docs.cortex.io/llms.txt > Use this file to discover all available pages before exploring further. # List workflows > List workflows. API key must have the `View workflows` permission. ## OpenAPI ````yaml /openapi/cortex_swagger.json get /api/v1/workflows openapi: 3.0.1 info: description: >- The Cortex REST API provides programmatic access to the data in the catalog, Scorecards, and more. title: Cortex API version: v1 servers: - url: https://api.getcortexapp.com description: Cortex Cloud API host security: - bearerAuth: [] tags: - name: API Keys - name: Audit Logs - name: Catalog Entities - name: Catalogs - name: Custom Data - name: Custom Data [Advanced] - name: Custom Events - name: Custom Metrics - name: Dependencies - name: Deploys - name: Discovery Audit - name: Docs - name: 'Eng Intel: 1-Registry' - name: 'Eng Intel: 2-Metrics' - name: 'Eng Intel: 3-Trace' - name: 'Eng Intel: User Labels' - name: Entity Relationship Types - name: Entity Relationships - name: Entity Types - name: GitOps Logs - name: Groups - name: IP Allowlist - name: Initiatives - name: My Workspace - name: Notification Logs - name: On-call - name: Packages - name: Plugins - name: Queries - name: SCIM - name: Scaffolder - name: Scorecards - name: Secrets - name: Team Roles - name: Teams - name: Teams Hierarchies - name: Teams [Advanced] - name: Teams [Departments] (legacy) - name: Users - name: Verifications - name: Workflows - name: '[Integrations] AWS' - name: '[Integrations] Anthropic' - name: '[Integrations] Apiiro' - name: '[Integrations] ArgoCD' - name: '[Integrations] Azure Active Directory' - name: '[Integrations] Azure Devops' - name: '[Integrations] Azure Resources' - name: '[Integrations] BambooHR' - name: '[Integrations] Bitbucket' - name: '[Integrations] Bugsnag' - name: '[Integrations] Buildkite' - name: '[Integrations] Checkmarx SAST' - name: '[Integrations] CircleCI' - name: '[Integrations] ClickUp' - name: '[Integrations] Codecov' - name: '[Integrations] Coralogix' - name: '[Integrations] Datadog' - name: '[Integrations] Dynatrace' - name: '[Integrations] Firehydrant' - name: '[Integrations] GitHub' - name: '[Integrations] GitLab' - name: '[Integrations] Harness' - name: '[Integrations] Incident.io' - name: '[Integrations] Instana' - name: '[Integrations] Jenkins' - name: '[Integrations] Jira' - name: '[Integrations] Kubernetes' - name: '[Integrations] LaunchDarkly' - name: '[Integrations] Lightstep' - name: '[Integrations] Mend SAST' - name: '[Integrations] Mend SCA' - name: '[Integrations] New Relic' - name: '[Integrations] Okta' - name: '[Integrations] Opsgenie' - name: '[Integrations] PagerDuty' - name: '[Integrations] Prometheus' - name: '[Integrations] Rollbar' - name: '[Integrations] Rootly' - name: '[Integrations] Semgrep' - name: '[Integrations] Sentry' - name: '[Integrations] ServiceNow' - name: '[Integrations] SignalFx' - name: '[Integrations] Snyk' - name: '[Integrations] SonarQube' - name: '[Integrations] SumoLogic' - name: '[Integrations] Veracode' - name: '[Integrations] VictorOps' - name: '[Integrations] Wiz' - name: '[Integrations] Workday' - name: '[Integrations] xMatters' - name: dev-login-controller - name: public-scim-schema-controller paths: /api/v1/workflows: get: tags: - Workflows summary: List workflows description: |- List workflows. API key must have the `View workflows` permission. operationId: listWorkflows parameters: - description: >- When true, returns the list of actions for each workflow. Defaults to false. in: query name: includeActions required: false schema: type: boolean default: false - description: >- When set, only returns workflows with the given substring in the name or description. in: query name: searchQuery required: false schema: type: string - description: >- Number of results to return per page, between 1 and 1000. Default 250. in: query name: pageSize required: true schema: type: integer format: int32 default: 250 - description: Page number to return, 0-indexed. Default 0. in: query name: page required: true schema: type: integer format: int32 default: 0 responses: '200': content: application/json: schema: $ref: '#/components/schemas/WorkflowListResponse' application/yaml: schema: $ref: '#/components/schemas/WorkflowListResponse' description: Successfully found workflows '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' application/yaml: schema: $ref: '#/components/schemas/ErrorResponse' description: Access denied '429': $ref: '#/components/responses/TooManyRequests' components: schemas: WorkflowListResponse: required: - page - total - totalPages - workflows type: object properties: page: type: integer description: Current page number, 0-indexed format: int32 total: type: integer description: Total number of results format: int32 totalPages: type: integer description: Total number of pages format: int32 workflows: type: array description: List of workflows items: $ref: '#/components/schemas/WorkflowDefinition' ErrorResponse: required: - message - type type: object properties: details: type: string errorCode: type: string gatewayHttpStatus: type: integer format: int32 httpStatus: type: integer format: int32 message: type: string requestId: type: string type: type: string enum: - INTEGRATION_MISSING - INTEGRATION_UNREGISTERED - INTEGRATION_UNSUPPORTED - INTEGRATION_GRAPHQL_ERROR - INTEGRATION_BAD_REQUEST - INTEGRATION_UNAUTHORIZED - INTEGRATION_FORBIDDEN - INTEGRATION_NOT_FOUND - INTEGRATION_UNPROCESSABLE_CONTENT - INTEGRATION_RATE_LIMITED - INTEGRATION_INTERNAL_ERROR - INTEGRATION_NOT_IMPLEMENTED - INTEGRATION_BAD_GATEWAY - INTEGRATION_UNAVAILABLE - INTEGRATION_GATEWAY_TIMEOUT - INTEGRATION_TIMED_OUT - INTEGRATION_CACHE_ERROR - INTEGRATION_UNHANDLED_HTTP_ERROR - INTEGRATION_UNHANDLED_EXCEPTION - INTEGRATION_UNEXPECTED_ERROR - ILLEGAL_ARGUMENT_ERROR - BAD_REQUEST - FORBIDDEN - NOT_FOUND - REQUEST_TIMEOUT - CONFLICT - UNHANDLED_EXCEPTION - UNCATEGORIZED - SERVICE_CREATOR - UNKNOWN_HOST - TOO_MANY_REQUESTS WorkflowDefinition: required: - actions - filter - isDraft - name - restrictActionCompletionToRunnerUser - tag - variables type: object properties: actions: type: array description: List of actions in the workflow items: $ref: '#/components/schemas/WorkflowAction' createdAt: type: string description: The date the workflow was created, in ISO 8601 format createdBy: oneOf: - $ref: '#/components/schemas/User' description: type: string description: Description of the workflow failedRunResponseTemplate: type: string description: Template for the response when the workflow run fails filter: $ref: '#/components/schemas/WorkflowFilter' iconTag: type: string description: Icon tag for the workflow isDraft: type: boolean description: Whether the workflow is a draft isRunnableViaApi: type: boolean description: Whether the workflow is runnable via the public API lastUpdatedAt: type: string description: The date the workflow was last updated, in ISO 8601 format lastUpdatedBy: oneOf: - $ref: '#/components/schemas/User' name: type: string description: Name of the workflow restrictActionCompletionToRunnerUser: type: boolean description: >- If true, only the user who started the workflow can complete actions. Defaults to false. runResponseTemplate: type: string description: >- Template for the response when the workflow is completed successfully runRestrictionPolicies: type: array description: List of restriction policies for the workflow items: $ref: '#/components/schemas/RestrictionPolicyRelationship' tag: type: string description: Tag of the workflow variables: type: array description: List of variable definitions for the workflow items: $ref: '#/components/schemas/WorkflowVariable' TooManyRequestsProblemDetail: required: - type - title - status type: object properties: detail: type: string instance: type: string format: uri-reference retryAfter: minimum: 0 type: integer description: The number of seconds until the rate limiting resets. format: int32 status: maximum: 599 minimum: 100 type: integer format: int32 enum: - 429 title: type: string type: type: string format: uri-reference WorkflowAction: required: - isRootAction - name - outgoingActions - schema - slug type: object properties: isRootAction: type: boolean description: >- Whether the action is the root action of the workflow. There can be only one root action per workflow name: type: string description: The name of the action outgoingActions: type: array description: The actions that will be executed after this action items: type: string description: The actions that will be executed after this action schema: $ref: '#/components/schemas/WorkflowActionSchema' slug: type: string description: The slug of the action description: List of actions in the workflow User: required: - name type: object properties: email: type: string description: Contact email example: cristina@cortex.io name: type: string description: Name example: Cristina Buenahora WorkflowFilter: required: - type type: object properties: type: type: string description: The type of the workflow filter enum: - GLOBAL - ENTITY description: Filter to determine in what entity contexts the workflow can run discriminator: propertyName: type oneOf: - $ref: '#/components/schemas/WorkflowFilter.GLOBAL' - $ref: '#/components/schemas/WorkflowFilter.ENTITY' RestrictionPolicyRelationship: required: - id - type type: object properties: id: type: string description: ID of the principal allowed to run the workflow type: type: string description: Type of the principal allowed to run the workflow enum: - USER - TEAM - CUSTOM_ROLE description: List of restriction policies for the workflow WorkflowVariable: required: - slug - type type: object properties: defaultValue: $ref: '#/components/schemas/JsonNode' description: type: string description: The description of the variable slug: type: string description: The slug of the variable type: type: string description: The type of the variable enum: - STRING - NUMBER - BOOLEAN - OBJECT - ARRAY_OF_STRING - ARRAY_OF_NUMBER - ARRAY_OF_BOOLEAN - ARRAY_OF_OBJECT description: List of variable definitions for the workflow WorkflowActionSchema: required: - type type: object properties: type: type: string description: The type of the action description: The definition of the action discriminator: propertyName: type oneOf: - $ref: '#/components/schemas/WorkflowActionSchema.HTTP_REQUEST' - $ref: '#/components/schemas/WorkflowActionSchema.ADVANCED_HTTP_REQUEST' - $ref: '#/components/schemas/WorkflowActionSchema.HTTP_REQUEST_ASYNC' - $ref: '#/components/schemas/WorkflowActionSchema.SCAFFOLDER' - $ref: '#/components/schemas/WorkflowActionSchema.USER_INPUT' - $ref: '#/components/schemas/WorkflowActionSchema.JQ' - $ref: '#/components/schemas/WorkflowActionSchema.SLACK' - $ref: '#/components/schemas/WorkflowActionSchema.MANUAL_APPROVAL' - $ref: '#/components/schemas/WorkflowActionSchema.CONDITIONAL_BRANCH' - $ref: >- #/components/schemas/WorkflowActionSchema.GITHUB_CREATE_OR_UPDATE_FILE - $ref: '#/components/schemas/WorkflowActionSchema.MS_TEAMS_SEND_MESSAGE' - $ref: '#/components/schemas/WorkflowActionSchema.JAVASCRIPT' - $ref: '#/components/schemas/WorkflowActionSchema.SET_VARIABLES' - $ref: '#/components/schemas/WorkflowActionSchema.AWS' - $ref: '#/components/schemas/WorkflowActionSchema.PAGERDUTY_CREATE_INCIDENT' - $ref: '#/components/schemas/WorkflowActionSchema.JIRA_CREATE_ISSUE' - $ref: '#/components/schemas/WorkflowActionSchema.RUN_WORKFLOW' WorkflowFilter.GLOBAL: title: GLOBAL type: object allOf: - $ref: '#/components/schemas/WorkflowFilter' WorkflowFilter.ENTITY: title: ENTITY type: object allOf: - $ref: '#/components/schemas/WorkflowFilter' - required: - ownershipScope - requiredTeamRoles type: object properties: entityFilter: $ref: '#/components/schemas/CompoundFilter' ownershipScope: type: string description: The ownership scope for the workflow enum: - ALL - OWNER - EDITOR requiredTeamRoles: type: array description: >- Tags of the team roles required to run the workflow. When non-empty, the runner must hold at least one of them on a team that owns the entity, in addition to what `ownershipScope` already requires. Only valid alongside an `ownershipScope` other than `ALL`. items: type: string description: >- Tags of the team roles required to run the workflow. When non-empty, the runner must hold at least one of them on a team that owns the entity, in addition to what `ownershipScope` already requires. Only valid alongside an `ownershipScope` other than `ALL`. JsonNode: type: object WorkflowActionSchema.HTTP_REQUEST: title: HTTP_REQUEST type: object allOf: - $ref: '#/components/schemas/WorkflowActionSchema' - required: - headers - httpMethod - type - url type: object properties: headers: type: object additionalProperties: type: string description: The headers for the HTTP request description: The headers for the HTTP request httpMethod: type: string description: The HTTP method for the request enum: - GET - POST - PUT - DELETE - PATCH integration: type: string description: The integration to use for authentication enum: - AzureDevops - Bitbucket - GitHub - LaunchDarkly - ServiceNow - GitLab - Pagerduty - Slack - Cortex - Jenkins - Google - Harness integrationAlias: type: string description: The alias of the integration configuration to use payload: type: string description: The payload for the request targetHost: type: string description: >- The *.googleapis.com host to target when using the Google Cloud integration. Setting this with any other integration is rejected as invalid. Defaults to cloudresourcemanager.googleapis.com when unset. type: type: string url: type: string description: The URL for the request WorkflowActionSchema.ADVANCED_HTTP_REQUEST: title: ADVANCED_HTTP_REQUEST type: object allOf: - $ref: '#/components/schemas/WorkflowActionSchema' - required: - actionIdentifier - inputs - type type: object properties: actionIdentifier: type: string inputs: type: object additionalProperties: $ref: '#/components/schemas/JsonNode' integrationAlias: type: string type: type: string WorkflowActionSchema.HTTP_REQUEST_ASYNC: title: HTTP_REQUEST_ASYNC type: object allOf: - $ref: '#/components/schemas/WorkflowActionSchema' - required: - headers - httpMethod - type - url type: object properties: headers: type: object additionalProperties: type: string description: The headers for the HTTP request description: The headers for the HTTP request httpMethod: type: string description: The HTTP method for the request enum: - GET - POST - PUT - DELETE - PATCH integration: type: string description: The integration to use for authentication enum: - AzureDevops - Bitbucket - GitHub - LaunchDarkly - ServiceNow - GitLab - Pagerduty - Slack - Cortex - Jenkins - Google - Harness integrationAlias: type: string description: The alias of the integration configuration to use payload: type: string description: The payload for the request targetHost: type: string description: >- The *.googleapis.com host to target when using the Google Cloud integration. Setting this with any other integration is rejected as invalid. Defaults to cloudresourcemanager.googleapis.com when unset. timeoutInSeconds: type: integer description: The timeout for the request in seconds format: int32 type: type: string url: type: string description: The URL for the request WorkflowActionSchema.SCAFFOLDER: title: SCAFFOLDER type: object allOf: - $ref: '#/components/schemas/WorkflowActionSchema' - required: - inputOverrides - type type: object properties: createNewRepository: type: boolean description: >- Whether the Scaffolder should create a new repository. Defaults to `true` createService: type: boolean description: Whether the cortex service should be created. inputOverrides: type: array description: The input overrides for the Scaffolder items: $ref: '#/components/schemas/InputOverride' scaffolderTemplateId: type: string description: >- On input, accepts either the tag or the Cortex ID of the Scaffolder template. On output, always the template's Cortex ID, or `null` if the referenced template was deleted. scaffolderTemplateTag: type: string description: >- The tag of the Scaffolder template. Preferred over `scaffolderTemplateId` when both are provided, so workflow definitions stay portable across workspaces. type: type: string WorkflowActionSchema.USER_INPUT: title: USER_INPUT type: object allOf: - $ref: '#/components/schemas/WorkflowActionSchema' - required: - inputOverrides - inputs - type type: object properties: inputOverrides: type: array description: The list of overrides for the action inputs items: $ref: '#/components/schemas/InputOverride' inputs: type: array description: The list of inputs required for the action items: $ref: '#/components/schemas/WorkflowInput' jsValidatorScript: type: string description: >- Optional JavaScript validator script to validate the provided inputs type: type: string WorkflowActionSchema.JQ: title: JQ type: object allOf: - $ref: '#/components/schemas/WorkflowActionSchema' - required: - expression - type type: object properties: expression: type: string description: The JQ expression for the action type: type: string WorkflowActionSchema.SLACK: title: SLACK type: object allOf: - $ref: '#/components/schemas/WorkflowActionSchema' - required: - channel - message - type type: object properties: channel: type: string description: >- The channel name to send the message to, without the `#`. For example for `#general` use `general` message: type: string description: The message to send type: type: string WorkflowActionSchema.MANUAL_APPROVAL: title: MANUAL_APPROVAL type: object allOf: - $ref: '#/components/schemas/WorkflowActionSchema' - required: - approvingTeamIds - type type: object properties: approverDescription: type: string description: A description that will be shown to approvers approvingTeamIds: type: array description: The IDs of the teams whose members can approve the action items: type: string description: The IDs of the teams whose members can approve the action approvingTeamIdsOverride: type: string description: >- The path to the override value in the workflow context that resolves the approving teams at run time. The value at the path must be an array of team Cortex IDs or team tags. type: type: string WorkflowActionSchema.CONDITIONAL_BRANCH: title: CONDITIONAL_BRANCH type: object allOf: - $ref: '#/components/schemas/WorkflowActionSchema' - required: - branches - type type: object properties: branches: type: array description: The list of conditional branches that will be evaluated in order items: $ref: '#/components/schemas/Conditional' fallbackBranch: $ref: '#/components/schemas/Fallback' joiningAction: type: string description: The joining action that will run after all branches type: type: string WorkflowActionSchema.GITHUB_CREATE_OR_UPDATE_FILE: title: GITHUB_CREATE_OR_UPDATE_FILE type: object allOf: - $ref: '#/components/schemas/WorkflowActionSchema' - required: - alias - commitMessage - content - path - repositoryName - type type: object properties: alias: type: string description: The alias for the github configuration to be used author: $ref: '#/components/schemas/GithubAuthor' branch: type: string description: >- The branch in the repository where the changes will be applied (optional; defaults to the main branch if not specified) commitMessage: type: string description: A message describing the purpose of the commit committer: $ref: '#/components/schemas/GithubCommitter' content: type: string description: >- The content of the file to be created or updated (not base64-encoded) path: type: string description: The full path to the file within the repository repositoryName: type: string description: >- The name of the repository where the file is being created or updated type: type: string WorkflowActionSchema.MS_TEAMS_SEND_MESSAGE: title: MS_TEAMS_SEND_MESSAGE type: object allOf: - $ref: '#/components/schemas/WorkflowActionSchema' - required: - channelId - message - teamId - type type: object properties: channelId: type: string description: The channel id to send the message to message: type: string description: The message to send teamId: type: string description: The team id to send the message to type: type: string WorkflowActionSchema.JAVASCRIPT: title: JAVASCRIPT type: object allOf: - $ref: '#/components/schemas/WorkflowActionSchema' - required: - script - type type: object properties: script: type: string description: The JavaScript script for the action type: type: string WorkflowActionSchema.SET_VARIABLES: title: SET_VARIABLES type: object allOf: - $ref: '#/components/schemas/WorkflowActionSchema' - required: - type - variables type: object properties: type: type: string variables: type: array description: The variables to set for the action items: $ref: '#/components/schemas/VariableAssignment' WorkflowActionSchema.AWS: title: AWS type: object allOf: - $ref: '#/components/schemas/WorkflowActionSchema' - required: - accountId - actionIdentifier - inputs - region - type type: object properties: accountId: type: string actionIdentifier: type: string inputs: type: object additionalProperties: $ref: '#/components/schemas/JsonNode' region: type: string type: type: string WorkflowActionSchema.PAGERDUTY_CREATE_INCIDENT: title: PAGERDUTY_CREATE_INCIDENT type: object allOf: - $ref: '#/components/schemas/WorkflowActionSchema' - required: - body - fromEmail - serviceId - title - type - urgency type: object properties: body: type: string description: The body of the incident fromEmail: type: string description: >- The email address of a valid user associated with the account making the request incidentTypeName: type: string description: The incident type name serviceId: type: string description: The ID of the service to create the incident for title: type: string description: The title of the incident type: type: string urgency: type: string description: The urgency of the incident enum: - HIGH - LOW WorkflowActionSchema.JIRA_CREATE_ISSUE: title: JIRA_CREATE_ISSUE type: object allOf: - $ref: '#/components/schemas/WorkflowActionSchema' - required: - alias - components - description - fields - issueSummary - issueType - labels - projectKey - type type: object properties: alias: type: string description: The alias for the Jira configuration that will be used. assignee: type: string description: >- The identifier of the assignee for the Jira issue. This field is optional. components: type: array description: >- A list of components within the Jira project to which the issue belongs. This field is optional. items: type: string description: >- A list of components within the Jira project to which the issue belongs. This field is optional. description: type: string description: >- A detailed description of the issue, providing more context about what needs to be addressed. fields: type: object additionalProperties: type: object description: >- A map containing additional fields that are to be provided for the Jira issue, such as custom fields or extra attributes. This field is optional. description: >- A map containing additional fields that are to be provided for the Jira issue, such as custom fields or extra attributes. This field is optional. issueSummary: type: string description: >- A brief summary of the issue being created, typically representing the title of the issue. issueType: type: string description: >- The type of the issue being created, such as 'Bug', 'Task', or 'Story'. labels: type: array description: >- A list of labels or tags to categorize or highlight the Jira issue. This field is optional. items: type: string description: >- A list of labels or tags to categorize or highlight the Jira issue. This field is optional. priority: type: string description: >- The priority of the issue, such as 'High', 'Medium', or 'Low'. This field is optional. projectKey: type: string description: >- The key of the Jira project where the issue will be created. Typically a short code like 'PROJ'. reporter: type: string description: >- The identifier of the reporter who is raising the Jira issue. This field is optional. type: type: string WorkflowActionSchema.RUN_WORKFLOW: title: RUN_WORKFLOW type: object allOf: - $ref: '#/components/schemas/WorkflowActionSchema' - required: - type - workflowId type: object properties: entityId: type: string description: The ID of the entity type: type: string workflowId: type: string description: The ID of the workflow to run CompoundFilter: type: object properties: entityGroupFilter: $ref: '#/components/schemas/EntityGroupFilterDTO1' typeFilter: $ref: '#/components/schemas/EntityTypeFilter1' description: The entity filter for the workflow InputOverride: required: - type type: object properties: type: type: string description: The type of the input override enum: - OPTION - VALUE description: The list of overrides for the action inputs discriminator: propertyName: type oneOf: - $ref: '#/components/schemas/Option' - $ref: '#/components/schemas/Value' WorkflowInput: required: - type type: object properties: type: type: string description: The type of the input enum: - INPUT_FIELD - TEXTAREA_FIELD - SELECT_FIELD - MULTISELECT_FIELD - TOGGLE_FIELD - CORTEX_ENTITY_FIELD - CORTEX_USER_FIELD - SLACK_FIELD - SECRET_FIELD - NUMBER_FIELD - DATE_FIELD - NESTED_FORM_FIELD description: The list of inputs required for the action discriminator: propertyName: type oneOf: - $ref: '#/components/schemas/WorkflowInput.INPUT_FIELD' - $ref: '#/components/schemas/WorkflowInput.TEXTAREA_FIELD' - $ref: '#/components/schemas/WorkflowInput.SELECT_FIELD' - $ref: '#/components/schemas/WorkflowInput.MULTISELECT_FIELD' - $ref: '#/components/schemas/WorkflowInput.TOGGLE_FIELD' - $ref: '#/components/schemas/WorkflowInput.CORTEX_ENTITY_FIELD' - $ref: '#/components/schemas/WorkflowInput.CORTEX_USER_FIELD' - $ref: '#/components/schemas/WorkflowInput.SLACK_FIELD' - $ref: '#/components/schemas/WorkflowInput.SECRET_FIELD' - $ref: '#/components/schemas/WorkflowInput.NUMBER_FIELD' - $ref: '#/components/schemas/WorkflowInput.DATE_FIELD' Conditional: required: - expression - name - slug type: object properties: expression: type: string description: The conditional expression for the branch name: type: string description: The name of the branch outgoingAction: type: string description: The first action to execute in this branch path slug: type: string description: The slug of the branch description: The list of conditional branches that will be evaluated in order Fallback: required: - name - slug type: object properties: name: type: string description: The name of the branch outgoingAction: type: string description: The first action to execute in this branch path slug: type: string description: The slug of the branch description: >- The fallback branch that will be taken if no other branches evaluate to `true` GithubAuthor: required: - email - name type: object properties: email: type: string name: type: string description: >- The details of the original author of the changes being committed (optional) GithubCommitter: required: - email - name type: object properties: email: type: string name: type: string description: >- The details of the person or system making the commit, such as name and email (optional) VariableAssignment: required: - slug - source type: object properties: slug: type: string description: The type of the variable source: oneOf: - $ref: '#/components/schemas/JavaScript' - $ref: '#/components/schemas/Reference' description: The variables to set for the action EntityGroupFilterDTO1: required: - entityGroups - excludedEntityGroups type: object properties: entityGroups: uniqueItems: true type: array description: The entity groups to include items: type: string description: The entity groups to include excludedEntityGroups: uniqueItems: true type: array description: The entity groups to exclude items: type: string description: The entity groups to exclude description: The entity group filter for the entity EntityTypeFilter1: required: - types type: object properties: types: uniqueItems: true type: array description: >- The entity types to include. Can be found on https://app.getcortexapp.com/admin/entities items: type: string description: >- The entity types to include. Can be found on https://app.getcortexapp.com/admin/entities Option: type: object allOf: - $ref: '#/components/schemas/InputOverride' - required: - inputKey - outputVariable - type type: object properties: inputKey: type: string description: The input key to override outputVariable: type: string description: The path to the override value in the workflow context type: type: string Value: type: object allOf: - $ref: '#/components/schemas/InputOverride' - required: - editable - inputKey - outputVariable - type type: object properties: editable: type: boolean description: >- Whether the override is editable by the user. Defaults to `false`. If set to `true` it'll pause the execution of the workflow and wait for the user to provide the value inputKey: type: string description: The input key to override outputVariable: type: string description: The path to the override value in the workflow context type: type: string WorkflowInput.INPUT_FIELD: title: INPUT_FIELD type: object allOf: - $ref: '#/components/schemas/WorkflowInput' - required: - key - name - required - type type: object properties: defaultValue: type: string description: The default value for the input description: type: string description: The description of the input key: type: string description: The key of the input name: type: string description: The name of the input placeholder: type: string description: The placeholder for the input required: type: boolean description: Whether the input is required type: type: string validationRegex: type: string description: The validation regex for the input WorkflowInput.TEXTAREA_FIELD: title: TEXTAREA_FIELD type: object allOf: - $ref: '#/components/schemas/WorkflowInput' - required: - key - name - required - type type: object properties: defaultValue: type: string description: The default value for the input description: type: string description: The description of the input key: type: string description: The key of the input name: type: string description: The name of the input placeholder: type: string description: The placeholder for the input required: type: boolean description: Whether the input is required type: type: string validationRegex: type: string description: The validation regex for the input WorkflowInput.SELECT_FIELD: title: SELECT_FIELD type: object allOf: - $ref: '#/components/schemas/WorkflowInput' - required: - allowAdditionalOptions - key - name - options - required - type type: object properties: allowAdditionalOptions: type: boolean description: Whether additional options are allowed. Defaults to `false` defaultValue: type: string description: The default value for the input description: type: string description: The description of the input key: type: string description: The key of the input name: type: string description: The name of the input options: type: array description: The list of options for the input items: type: string description: The list of options for the input optionsLabels: type: array description: >- The list of labels for the options. If not provided, the options will be used as labels items: type: string description: >- The list of labels for the options. If not provided, the options will be used as labels placeholder: type: string description: The placeholder value for the input required: type: boolean description: Whether the input is required type: type: string WorkflowInput.MULTISELECT_FIELD: title: MULTISELECT_FIELD type: object allOf: - $ref: '#/components/schemas/WorkflowInput' - required: - allowAdditionalOptions - key - name - options - required - type type: object properties: allowAdditionalOptions: type: boolean description: Whether additional options are allowed. Defaults to `false` defaultValue: type: array description: The default value for the input items: type: string description: The default value for the input description: type: string description: The description of the input key: type: string description: The key of the input name: type: string description: The name of the input options: type: array description: The list of options for the input items: type: string description: The list of options for the input optionsLabels: type: array description: >- The list of labels for the options. If not provided, the options will be used as labels items: type: string description: >- The list of labels for the options. If not provided, the options will be used as labels placeholder: type: string description: The placeholder value for the input required: type: boolean description: Whether the input is required type: type: string WorkflowInput.TOGGLE_FIELD: title: TOGGLE_FIELD type: object allOf: - $ref: '#/components/schemas/WorkflowInput' - required: - key - name - required - type type: object properties: defaultValue: type: boolean description: The default value for the input description: type: string description: The description of the input key: type: string description: The key of the input name: type: string description: The name of the input required: type: boolean description: Whether the input is required type: type: string WorkflowInput.CORTEX_ENTITY_FIELD: title: CORTEX_ENTITY_FIELD type: object allOf: - $ref: '#/components/schemas/WorkflowInput' - required: - allowMultiple - entityFilter - key - limitEntitiesToRunnerUserScope - name - required - shouldDisplayOptionsAsHierarchy - type type: object properties: allowMultiple: type: boolean description: Whether the input allows multiple values. Defaults to `false` defaultValue: type: array description: The default value for the input items: type: string description: The default value for the input description: type: string description: The description of the input entityFilter: $ref: '#/components/schemas/WorkflowInputEntityFilter' key: type: string description: The key of the input limitEntitiesToRunnerUserScope: type: boolean description: >- Whether to limit entity options to the workflow runner's entities. Defaults to `false` name: type: string description: The name of the input placeholder: type: string description: The placeholder for the input required: type: boolean description: Whether the input is required shouldDisplayOptionsAsHierarchy: type: boolean description: >- Whether the options should be displayed as a hierarchy. Defaults to `false` type: type: string WorkflowInput.CORTEX_USER_FIELD: title: CORTEX_USER_FIELD type: object allOf: - $ref: '#/components/schemas/WorkflowInput' - required: - allowMultiple - filter - key - name - required - type type: object properties: allowMultiple: type: boolean description: Whether the input allows multiple values. Defaults to `false` defaultValue: type: array description: The default value for the input items: $ref: '#/components/schemas/CortexUserIdentity' description: type: string description: The description of the input filter: $ref: '#/components/schemas/WorkflowInputUserFilter' key: type: string description: The key of the input name: type: string description: The name of the input placeholder: type: string description: The placeholder for the input required: type: boolean description: Whether the input is required type: type: string WorkflowInput.SLACK_FIELD: title: SLACK_FIELD type: object allOf: - $ref: '#/components/schemas/WorkflowInput' - required: - allowMultiple - filter - key - name - required - type type: object properties: allowMultiple: type: boolean description: Whether the input allows multiple values. Defaults to `false` defaultValue: type: array description: The default value for the input items: type: string description: The default value for the input description: type: string description: The description of the input filter: $ref: '#/components/schemas/WorkflowInputSlackFilter' key: type: string description: The key of the input name: type: string description: The name of the input placeholder: type: string description: The placeholder for the input required: type: boolean description: Whether the input is required type: type: string WorkflowInput.SECRET_FIELD: title: SECRET_FIELD type: object allOf: - $ref: '#/components/schemas/WorkflowInput' - required: - disabled - key - name - required - type type: object properties: description: type: string description: The description of the input disabled: type: boolean description: Whether the input should be disabled key: type: string description: The key of the input name: type: string description: The name of the input placeholder: type: string description: The placeholder for the input required: type: boolean description: Whether the input is required type: type: string validationRegex: type: string description: The validation regex for the input WorkflowInput.NUMBER_FIELD: title: NUMBER_FIELD type: object allOf: - $ref: '#/components/schemas/WorkflowInput' - required: - disabled - format - key - name - required - type type: object properties: defaultValue: type: number description: The default value for the input description: type: string description: The description of the input disabled: type: boolean description: Whether the input should be disabled format: type: string description: The number format of the input enum: - INTEGER - DECIMAL key: type: string description: The key of the input max: type: number description: The maximum value of the input min: type: number description: The minimum value of the input name: type: string description: The name of the input placeholder: type: string description: The placeholder for the input required: type: boolean description: Whether the input is required type: type: string WorkflowInput.DATE_FIELD: title: DATE_FIELD type: object allOf: - $ref: '#/components/schemas/WorkflowInput' - required: - disabled - format - key - name - required - type type: object properties: defaultValue: type: string description: The default value for the input description: type: string description: The description of the input disabled: type: boolean description: Whether the input should be disabled format: type: string description: The date format of the input enum: - DATE - DATETIME key: type: string description: The key of the input name: type: string description: The name of the input placeholder: type: string description: The placeholder for the input required: type: boolean description: Whether the input is required type: type: string JavaScript: type: object allOf: - $ref: '#/components/schemas/VariableSource' - required: - script type: object properties: script: type: string Reference: type: object allOf: - $ref: '#/components/schemas/VariableSource' - required: - path type: object properties: path: type: string WorkflowInputEntityFilter: type: object properties: domainIds: type: array description: Restrict options to entities related to the provided domains items: type: string description: Restrict options to entities related to the provided domains emailOwners: type: array description: Restrict options to entities owned by the provided users items: type: string description: Restrict options to entities owned by the provided users excludedGroupTags: type: array description: Restrict options to entities in the provided groups items: type: string description: Restrict options to entities in the provided groups groupTags: type: array description: Restrict options to entities not in the provided groups items: type: string description: Restrict options to entities not in the provided groups teamIds: type: array description: Restrict options to entities owned by the provided teams items: type: string description: Restrict options to entities owned by the provided teams typeFilter: $ref: '#/components/schemas/EntityTypeFilter1' description: The entity filter for the input CortexUserIdentity: required: - email - name type: object properties: email: type: string description: The email of the user name: type: string description: The name of the user description: The default value for the input WorkflowInputUserFilter: type: object properties: teamCids: type: array description: Restrict options to users on the provided teams items: type: string description: Restrict options to users on the provided teams userEmails: type: array description: Restrict options to users with the provided emails items: type: string description: Restrict options to users with the provided emails description: The user filter for the input WorkflowInputSlackFilter: required: - channels type: object properties: channels: type: array description: Restrict options to the provided channels items: type: string description: Restrict options to the provided channels description: The filters for the input VariableSource: required: - type type: object properties: type: type: string description: How to set the variable discriminator: propertyName: type responses: TooManyRequests: content: application/problem+json: schema: $ref: '#/components/schemas/TooManyRequestsProblemDetail' description: >- The client has exceeded the rate limit by performing too many requests in a short period. Retry the request after a delay. headers: Retry-After: description: The number of seconds until the rate limiting resets. schema: minimum: 0 type: integer format: int32 securitySchemes: bearerAuth: bearerFormat: JWT description: >- All requests to the Cortex API need to provide an `Authorization: Bearer ` header, where `` is an API key created in the Settings page of your workspace. scheme: bearer type: http ```` ## Related topics - [Workflows](/api/rest/workflows.md) - [List workflow runs](/api/rest/workflows/list-workflow-runs.md) - [Using the Cortex MCP](/get-started/cortex-ai-assistant/mcp/using-cortex-mcp.md)