client.workflows.list

A method of the Workflows endpoint.

list(*, hidden: bool = None, archived: str = None, author: str = None, state: List[str] = None, scheduled: bool = None, limit: int = None, page_num: int = None, order: str = None, order_dir: str = None, iterator: bool = None) → ListResponse | PaginatedResponse

List Workflows

API URL: GET /workflows

import civis
client = civis.APIClient()
response = client.workflows.list(...)
Parameters:
hiddenbool, optional

If specified to be true, returns hidden items. Defaults to false, returning non-hidden items.

archivedstr, optional

The archival status of the items to return. One of: true, false, all. A blank value is read as ‘false’, which is also the default.

authorstr, optional

If specified, return items from any of these authors. It accepts a comma- separated list of user IDs.

stateList[str], optional

State of the most recent execution. One or more of queued, running, succeeded, failed, cancelled, idle or scheduled. Note that the “scheduled” state applies only to scheduled workflows which have never been run. If you want to see all scheduled workflows, please use the “scheduled” filter instead.

scheduledbool, optional

If the workflow is scheduled.

limitint, optional

Number of results to return. Defaults to 20. Maximum allowed is 50.

page_numint, optional

Page number of the results to return. Defaults to the first page, 1.

orderstr, optional

The field on which to order the result set. Defaults to updated_at. Must be one of: updated_at, name, created_at.

order_dirstr, optional

Direction in which to sort, either asc (ascending) or desc (descending) defaulting to desc.

iteratorbool, optional

If True, return a generator (specifically, a civis.PaginatedResponse object) to iterate over all responses. Use it when more results than the maximum allowed by ‘limit’ are needed. When True, ‘page_num’ is ignored. If False, return a civis.ListResponse object (= a list of civis.Response objects), whose size is determined by ‘limit’. Defaults to False.

Returns:
civis.ListResponse | civis.PaginatedResponse
  • idint

    The ID for this workflow.

  • namestr

    The name of this workflow.

  • descriptionstr

    A description of the workflow.

  • validbool

    The validity of the workflow definition.

  • file_idstr

    The file id for the s3 file containing the workflow configuration.

  • usercivis.Response
    • idint

      The ID of this user.

    • namestr

      This user’s name.

    • usernamestr

      This user’s username.

    • initialsstr

      This user’s initials.

    • onlinebool

      Whether this user is online.

  • statestr

    The state of the workflow. State is “running” if any execution is running, otherwise reflects most recent execution state.

  • schedulecivis.Response
    • scheduledbool

      If the item is scheduled.

    • scheduled_daysList[int]

      Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth

    • scheduled_hoursList[int]

      Hours of the day it is scheduled on.

    • scheduled_minutesList[int]

      Minutes of the day it is scheduled on.

    • scheduled_runs_per_hourint

      Deprecated in favor of scheduled minutes.

    • scheduled_days_of_monthList[int]

      Days of the month it is scheduled on, mutually exclusive with scheduledDays.

  • allow_concurrent_executionsbool

    Whether the workflow can execute when already running.

  • time_zonestr

    The time zone of this workflow.

  • next_execution_atstr (time)

    The time of the next scheduled execution.

  • archivedbool

    The archival status of the requested item(s).

  • created_at : str (time)

  • updated_at : str (time)