> ## Documentation Index > Fetch the complete documentation index at: https://www.1password.dev/llms.txt > Use this file to discover all available pages before exploring further. # List workflows > Returns a paginated list of the published workflows in your organization, including each workflow's trigger and steps. Use `filter` and `q` to narrow the results, and follow the `next` link (also provided in the `link` response header) to page through large result sets. **Required scope:** `Workflows.Read` (Read-only access to workflow definitions) ## OpenAPI ````yaml /openapi/saas_manager_api.json get /api/workflows/v1 openapi: 3.0.4 info: title: SaaS Manager API description: >- By accessing or using 1Password Developer Tools, you agree to the [API and SDK Terms of Service](https://1password.com/legal/api-sdk-terms-of-service). --- The SaaS Manager public REST API lets you read and manage your applications, people, teams, contracts, devices, workflows and audit log programmatically. Resources are grouped by area (see the navigation). The conventions below apply across the whole API. ## Regions and base URL SaaS Manager is hosted in multiple regions. Pick the base URL for your tenant's region from the **Servers** dropdown — `https://app.trelica.com` (United States) or `https://eu.trelica.com` (Europe). Endpoint URLs throughout this reference use whichever server you select. ## Authentication Every request must send an `Authorization` header carrying an OAuth 2.0 access token, prefixed with `Bearer`: ``` Authorization: Bearer ``` Obtain a token using either the **Client Credentials** flow (machine-to-machine) or the **Authorization Code** flow (acting on behalf of a user). The scopes granted to your token determine which endpoints you may call — see [Scopes](#scopes). Access tokens expire. When a token is missing, invalid or expired you receive `401 Unauthorized`; inspect the `WWW-Authenticate` response header for detail, for example: ``` Bearer error="invalid_token", error_description="The token expired at '12/23/2020 10:27:15'" ``` If you used the Authorization Code flow with the `offline_access` scope, use your refresh token to obtain a new access token. A `403 Forbidden` means the token is valid but lacks the scope required by the endpoint. ## Dates and times Dates and date/times are sent and returned in [RFC 3339](https://tools.ietf.org/html/rfc3339) format (essentially ISO 8601), for example `2020-12-25` (midnight) or `2020-12-25T10:50:00Z`. Field names ending in `Dtm` carry a meaningful time component; field names ending in `Date` are date-only. ## Optional fields and null Responses omit fields that have no value — you will see the field absent rather than returned as `null`. When creating or replacing a resource (`PUT`), any field you omit is cleared. With `PATCH`, omitting a field leaves it unchanged, whereas sending it as `null` clears it. ## Pagination List endpoints are paginated and return at most 100 results by default. Request a different upper bound with the `limit` query parameter (maximum 1000) — you may receive fewer than requested. Request the next page with the `after` query parameter, passing the opaque cursor token that SaaS Manager supplies. The response's `next` field (and the `link` response header, `rel="next"`) contains the full URL for the next page: ```json { "next": "https://app.trelica.com/api/people/v1?after=&limit=100", "results": [ { /* ... */ } ] } ``` Keep requesting pages until no further results are returned. (User data exposed over SCIM uses the SCIM `startIndex`/`count` pagination scheme instead.) ## Filtering Many list endpoints accept a `filter` query parameter (URL-encoded) based on the [SCIM filtering specification](https://tools.ietf.org/html/rfc7644#section-3.4.2.2). A filter is one or more expressions — an attribute name, an operator, and an optional value — combined with `and`, `or`, `not`, and grouped with parentheses. Attribute names match the JSON returned and may use dot notation for nested attributes (e.g. `createdBy.email`). For an attribute that is an **array of objects**, put a sub-expression in brackets — the item matches when *any* element satisfies it: `teams[name eq "Developers"]` or `teams[id eq "5f8d0a1b2c3d4e5f60718293"]`. Values are strings (double-quoted), integers, dates (double-quoted, RFC 3339) or booleans. Some list endpoints also accept a free-text `q` parameter that searches the resource's displayable fields. Soft-deleted entities are excluded by default; include them with a filter that references `deleted` (e.g. `filter=deleted eq true`). | Operator | Meaning | Behaviour | |----------|---------|-----------| | `eq` | equal | Attribute value is identical to the operator value | | `ne` | not equal | Attribute value differs from the operator value | | `co` | contains | Attribute value contains the operator value text | | `sw` | starts with | Attribute value starts with the operator value text | | `ew` | ends with | Attribute value ends with the operator value text | | `pr` | present | Attribute has a non-empty / non-null value | | `gt` | greater than | Attribute value is greater than the operator value | | `ge` | greater than or equal | Attribute value is greater than or equal to the operator value | | `lt` | less than | Attribute value is less than the operator value | | `le` | less than or equal | Attribute value is less than or equal to the operator value | For `gt`/`ge`/`lt`/`le`, strings compare lexicographically, dates chronologically and numbers numerically. Each list endpoint documents the fields you can filter on. **Examples** | Filter | Result | |--------|--------| | `firstName sw "Jan"` | People whose first name starts with "Jan" | | `teams[name eq "Developers"]` | People in the team called Developers | | `not (leavingDate pr)` | People with no leaving date | | `lastModifiedDtm ge "2021-06-01"` | Records modified on or after 1 June 2021 | ## Errors A `400 Bad Request` indicates a problem with your request. The body is a problem-details object: `errors` maps each offending field to its messages, with `title`, `status`, a `type` URL, and an `extensions.traceId` for correlation: ```json { "errors": { "leavingDate": [ "Error converting value \"2020-40-40\" ..." ] }, "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1", "title": "One or more validation errors occurred.", "status": 400, "extensions": { "traceId": "00-91e4405b...-00" } } ``` You should not normally see `500 Internal Server Error`. If you do, the body is a generic message — please contact [saasmanager@1password.com](mailto:saasmanager@1password.com) with details of the request so we can investigate. ## Scopes Scopes define what an API app may do. Following security best practice, grant only the scopes you need. Each endpoint documents the scope(s) it requires. | Scope | Description | |-------|-------------| | `Apps.Read` | Read-only access to applications | | `Apps.Users.Read` | Read-only access to application accounts | | `Apps.Write` | Write access to applications | | `Assets.Read` | Read-only access to devices | | `Assets.Write` | Write access to devices | | `AuditLog.Read` | Read-only access to the audit log | | `Contracts.Read` | Read-only access to contracts | | `Contracts.Write` | Write access to contracts | | `People.Read` | Read-only access to people and teams | | `People.Write` | Write access to people and teams | | `Users.Read` | Read-only access to users with access to SaaS Manager | | `Users.Write` | Write access to users with access to SaaS Manager | | `Workflows.Read` | Read-only access to workflow definitions | | `Workflows.Runs.Read` | Read-only access to workflow runs | | `Workflows.Runs.Execute` | Execute workflow run actions | | `Workflows.Runs.ReadSecrets` | Read workflow run secrets | | `offline_access` | Issue a refresh token alongside the access token (Authorization Code flow) | contact: name: 1Password SaaS Manager Support email: saasmanager@1password.com version: v1 servers: - url: https://app.trelica.com description: United States - url: https://eu.trelica.com description: Europe security: [] tags: - name: Authentication description: >- Obtain an OAuth 2.0 access token. Use the Client Credentials flow for machine-to-machine access, or the Authorization Code flow to act on behalf of a user. - name: Applications description: >- List, search and manage applications, and list the accounts (users) on an application. - name: People description: List, search and manage the people in your organization. - name: Teams description: List and manage teams and the team hierarchy. - name: Contracts description: List and manage contracts. - name: Devices description: List and manage devices. The endpoints live under `/api/assets`. - name: Workflows description: >- List workflows (with their triggers and steps), list their runs, and fire signals on steps that are waiting for input. - name: Audit log description: >- Read your organization's audit log: a continuous, filterable stream of events. - name: SCIM description: >- Provision and manage users via the SCIM 2.0 protocol (RFC 7644). These endpoints follow the SCIM standard rather than the conventions used by the rest of the SaaS Manager API: they use `startIndex`/`count` paging, return a SCIM `ListResponse` envelope, identify schemas with `urn:` URIs, and exchange `application/scim+json`. The `ResourceTypes` endpoints support SCIM discovery (RFC 7643). paths: /api/workflows/v1: get: tags: - Workflows summary: List workflows description: >- Returns a paginated list of the published workflows in your organization, including each workflow's trigger and steps. Use `filter` and `q` to narrow the results, and follow the `next` link (also provided in the `link` response header) to page through large result sets. **Required scope:** `Workflows.Read` (Read-only access to workflow definitions) parameters: - name: filter in: query description: >- A SCIM-style filter expression restricting the items returned. See the Filtering section of the introduction for the operators and syntax; the filterable fields are listed per resource. **Filterable fields** - **string:** `createdBy.email`, `createdBy.name`, `createdBy.userId`, `id`, `lastModifiedBy.email`, `lastModifiedBy.name`, `lastModifiedBy.userId`, `name`, `steps[customName]`, `steps[id]`, `steps[name]`, `steps[type]`, `trigger.dayOfWeek`, `trigger.id`, `trigger.name`, `trigger.period`, `trigger.type` - **number:** `trigger.everyNPeriods`, `trigger.hour` - **date:** `createdDtm`, `lastModifiedDtm`, `trigger.startDate` - **boolean:** `deleted`, `enabled` **Filter examples** - `name eq "Onboarding workflow"` — The workflow named "Onboarding workflow" - `name sw "Contr"` — Workflows whose name starts with "Contr", e.g. "Contractor offboarding" - `trigger.type eq "PersonFilter"` — Workflows triggered by a person filter - `enabled eq true` — Workflows that are enabled - `lastModifiedDtm ge "2022-01-01"` — Workflows modified on or after 1 Jan 2022 - `deleted eq true` — Show deleted workflows (excluded by default) schema: type: string - name: q in: query description: Free-text search across the resource's displayable fields. schema: type: string - name: since in: query description: Only return items modified at or after this ISO-8601 timestamp. schema: type: string format: date-time - name: until in: query description: Only return items modified at or before this ISO-8601 timestamp. schema: type: string format: date-time - name: after in: query description: >- Opaque pagination cursor supplied by SaaS Manager via the `link` response header and the `next` field. schema: type: string - name: limit in: query description: >- Maximum number of items to return per page (default 100, maximum 1000). schema: maximum: 1000 minimum: 1 type: integer default: 100 responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/WorkflowPage' example: next: >- https://app.trelica.com/api/workflows/v1?after=eyJpZCI6ImI3Mjg4YzJjNjRmNzc5ZTI4MDI0ZWEwZSJ9&limit=100 results: - id: b7288c2c64f779e28024ea0e name: Offboarding enabled: true createdDtm: '2023-06-22T14:02:36.136Z' deleted: false lastModifiedBy: userId: b2c3d4e5-f678-90ab-cdef-1234567890ab name: Priya Patel email: priya.patel@example.com lastModifiedDtm: '2023-06-22T20:28:35.846Z' trigger: id: 5e0e8a1c64f779e28024ea0d name: Person leaves type: PersonLeaves steps: - id: 4f2f9f6850fb2ce64a8ffb04 name: Create task type: CreateTask - id: f82c5f04e4b54a96f20ff8b5 name: Create Jira (Cloud) ticket type: CreateExternalTask - id: f9bff20456884e0f2c2f65ab name: Offboard person from apps type: OffboardPersonApps '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Error' example: type: about:blank title: One or more validation errors occurred. status: 400 detail: >- The request body failed validation. See errors for the offending fields. errors: email: - The email field is required. traceId: 00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01 '401': description: Unauthorized '403': description: Forbidden security: - oauth2: - Workflows.Read components: schemas: WorkflowPage: type: object properties: next: type: string description: >- The URL of the next page of results. Absent when there are no more results. results: type: array items: $ref: '#/components/schemas/Workflow' description: The page of results. additionalProperties: false Error: type: object properties: type: type: string description: A URI reference identifying the problem type. title: type: string description: A short, human-readable summary of the problem. status: type: integer description: The HTTP status code. format: int32 detail: type: string description: >- A human-readable explanation specific to this occurrence of the problem. errors: type: object additionalProperties: type: array items: type: string description: Validation errors keyed by field name. Present on 400 responses. traceId: type: string description: >- A trace identifier for correlating the error with SaaS Manager support. additionalProperties: false description: An error response (RFC 7807 problem details). Workflow: type: object properties: id: type: string description: The workflow's unique ID. name: type: string description: The workflow's name. description: type: string description: The workflow's description. enabled: type: boolean description: Whether the workflow is enabled and can run. createdBy: allOf: - $ref: '#/components/schemas/UserInfoFlow' description: The user who created the workflow. createdDtm: type: string description: When the workflow was created (UTC). format: date-time deleted: type: boolean description: >- Whether the workflow has been deleted. Deleted workflows are excluded unless the filter references this field. lastModifiedBy: allOf: - $ref: '#/components/schemas/UserInfoFlow' description: The user who last modified the workflow. lastModifiedDtm: type: string description: When the workflow was last modified (UTC). format: date-time trigger: allOf: - $ref: '#/components/schemas/WorkflowStep' description: The trigger that starts the workflow. steps: type: array items: $ref: '#/components/schemas/WorkflowStep' description: The steps that make up the workflow. additionalProperties: false UserInfoFlow: type: object properties: userId: type: string name: type: string email: type: string additionalProperties: false WorkflowStep: type: object properties: id: type: string description: The step's unique ID. name: type: string description: The step's name. description: type: string description: The step's description. type: type: string description: The step type, e.g. "PersonFilter", "SendEmail", "Wait". startDate: type: string description: 'For a schedule trigger: the date the schedule starts from.' format: date-time hour: type: integer description: >- For a schedule trigger: the hour of the day (0-23) the trigger runs at. format: int32 period: type: string description: >- For a schedule trigger: the recurrence period, e.g. "Day", "Week", "Month". everyNPeriods: type: integer description: >- For a schedule trigger: how many periods between runs (e.g. 2 = every 2 weeks). format: int32 dayOfWeek: type: string description: 'For a weekly schedule trigger: the day of the week, e.g. "Mon".' additionalProperties: false securitySchemes: oauth2: type: oauth2 description: >- OAuth 2.0. Obtain an access token via the Client Credentials or Authorization Code flow, then send it as `Authorization: Bearer `. flows: clientCredentials: tokenUrl: https://app.trelica.com/connect/token scopes: Apps.Read: Read-only access to applications Apps.Users.Read: Read-only access to application accounts Apps.Write: Write access to applications Assets.Read: Read-only access to devices Assets.Write: Write access to devices AuditLog.Read: Read-only access to the audit log Contracts.Read: Read-only access to contracts Contracts.Write: Write access to contracts People.Read: Read-only access to people and teams People.Write: Write access to people and teams Users.Read: Read-only access to users with access to SaaS Manager Users.Write: Write access to users with access to SaaS Manager Workflows.Read: Read-only access to workflow definitions Workflows.Runs.Read: Read-only access to workflow runs Workflows.Runs.Execute: Execute workflow run actions Workflows.Runs.ReadSecrets: Read workflow run secrets offline_access: >- Issue a refresh token alongside the access token (Authorization Code flow) authorizationCode: authorizationUrl: https://app.trelica.com/connect/authorize tokenUrl: https://app.trelica.com/connect/token scopes: Apps.Read: Read-only access to applications Apps.Users.Read: Read-only access to application accounts Apps.Write: Write access to applications Assets.Read: Read-only access to devices Assets.Write: Write access to devices AuditLog.Read: Read-only access to the audit log Contracts.Read: Read-only access to contracts Contracts.Write: Write access to contracts People.Read: Read-only access to people and teams People.Write: Write access to people and teams Users.Read: Read-only access to users with access to SaaS Manager Users.Write: Write access to users with access to SaaS Manager Workflows.Read: Read-only access to workflow definitions Workflows.Runs.Read: Read-only access to workflow runs Workflows.Runs.Execute: Execute workflow run actions Workflows.Runs.ReadSecrets: Read workflow run secrets offline_access: >- Issue a refresh token alongside the access token (Authorization Code flow) ```` ## Related topics - [List workflow runs](/api-reference/workflows/list-workflow-runs.md) - [List vaults and items using 1Password SDKs](/sdks/list-vaults-items.md) - [Programmatically manage your 1Password organization](/get-started/manage-organization.md)