> ## Documentation Index > Fetch the complete documentation index at: https://widgetic.com/llms.txt > Use this file to discover all available pages before exploring further. # List the Workflows of a Workspace > Lists the workspace's workflows, newest first unless `sort` says otherwise. Archived workflows are left out unless `status` asks for them (`archived`, or `all`). For personal workspace, use 'personal' as workspaceId. For organization workspace, use the organization UUID as workspaceId. Any active member can read the list. ## OpenAPI ````yaml /openapi/widgetic-api-public.json get /workspaces/{workspaceId}/workflows openapi: 3.0.0 info: title: Widgetic API Gateway version: 1.0.0 description: API documentation for the Widgetic API Gateway license: name: Widgetic Integration License url: https://docs.widgetic.com/resources/license servers: - url: https://api.widgetic.com/v1 description: Production server variables: env: default: production description: Environment apiUrl: default: https://api.widgetic.com description: API URL apiVersion: default: /v1 description: API Version path prefix security: [] tags: [] paths: /workspaces/{workspaceId}/workflows: get: tags: - Workflows summary: List the Workflows of a Workspace description: > Lists the workspace's workflows, newest first unless `sort` says otherwise. Archived workflows are left out unless `status` asks for them (`archived`, or `all`). For personal workspace, use 'personal' as workspaceId. For organization workspace, use the organization UUID as workspaceId. Any active member can read the list. operationId: listWorkspaceWorkflows parameters: - $ref: '#/components/parameters/WorkflowWorkspaceId' - name: search in: query required: false description: Text the workflow's name must contain schema: type: string maxLength: 120 - name: status in: query required: false description: >- One state to list (`draft`, `live`, `paused`, `archived`), or `all` for every state. Without it, the ones in use (draft, live and paused). schema: type: string enum: - draft - live - paused - archived - all - name: sort in: query required: false description: >- `:` where field is createdAt, lastPublishedAt, runsCount or name (or just asc / desc for createdAt). Newest first when not given. schema: type: string example: runsCount:desc - name: limit in: query required: false description: Page size (1-100, 50 when not given) schema: type: integer - name: offset in: query required: false description: How many to skip (0 when not given) schema: type: integer - $ref: '#/components/parameters/ManagedUserScopeId' - $ref: '#/components/parameters/ManagedUserScopeExternalId' responses: '200': description: A page of the workspace's workflows content: application/json: schema: type: object properties: success: type: boolean example: true data: $ref: '#/components/schemas/WorkflowList' meta: $ref: '#/components/schemas/ResponseMeta' required: - success - data '400': description: >- The workspace is neither "personal" nor an organization id, or a query value is not one this list accepts content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: >- Forbidden - Not a member of this organization, the plan does not include workflows (`AUTHZ_PLAN_RESTRICTION`), or the call is made for one managed user (`X-Managed-User-Id`) in a workspace other than `personal` (`MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`) content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '503': description: Workflows cannot be used on this server right now content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - apiKeyAuth: [] components: parameters: WorkflowWorkspaceId: name: workspaceId in: path required: true description: > The workspace: 'personal' for your own workspace, or the UUID of an organization. A call made for one of your managed users (`X-Managed-User-Id`) always uses 'personal': a managed user has no other workspace, and a call that names an organization is refused with 403. schema: type: string example: personal ManagedUserScopeId: in: header name: X-Managed-User-Id required: false description: >- The id Widgetic gave the managed user (`POST /managed-users`). Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. schema: type: string format: uuid example: 3f2b8c1e-7a4d-4e0b-9c55-2d1a6b7e8f90 ManagedUserScopeExternalId: in: header name: X-Managed-User-External-Id required: false description: >- Your own id for the managed user (its `externalId`), when you do not keep Widgetic's. Makes this call for one of your managed users, so that a mistake in your own code cannot reach another customer's work. Send this header, or the other one, never both. Left out, the call works on your whole account, as it always has. With it, the call reaches only that user's compositions and workflows: a list shows only theirs, a composition or a workflow the call makes is filed under them, and one of another user, or one that does not exist, answers `404` (the same answer, so the call cannot be used to find out what another customer has). A managed user that is not yours answers `404` with `MANAGED_USER_NOT_FOUND`. An empty, repeated or malformed header is `400` with `MANAGED_USER_SCOPE_INVALID`; an empty header is never read as no header. A call that is about the whole account, such as the list of your managed users, is refused with `403` and `MANAGED_USER_SCOPE_ROUTE_NOT_AVAILABLE`: send it without the header. Only your API key can send it. The header is a limit the call asks for: whoever holds the key can leave it out, so for a credential that a customer's browser holds, use an editor session. An `Idempotency-Key` is kept apart for each managed user. schema: type: string minLength: 1 maxLength: 255 example: customer-1042 schemas: WorkflowList: type: object required: - items - total - limit - offset properties: items: type: array items: $ref: '#/components/schemas/Workflow' total: type: integer limit: type: integer offset: type: integer example: items: - Example Workflow total: 42 limit: 42 offset: 42 ResponseMeta: type: object description: >- Extra information about the answer: where a page sits in a list, the cursor of the next page, or warnings about a call that succeeded with a caveat. additionalProperties: true properties: page: type: integer description: The page that was read, counting from 1. example: 1 size: type: integer description: How many items one page holds. example: 20 total: type: integer description: How many items the whole list has. example: 135 limit: type: integer description: The same as `size`. example: 20 offset: type: integer description: How many items come before this page. example: 0 hasNextPage: type: boolean example: true hasPreviousPage: type: boolean example: false nextCursor: type: string nullable: true description: >- Pass this as `cursor` to read the next page of a list that is read by cursor. `null` on the last page. warnings: type: array items: type: string description: >- Things the call did not do, though it succeeded (for example a table that could not be created just now). ErrorResponse: type: object required: - success - message - error additionalProperties: true properties: success: type: boolean description: Always `false` on a failure. example: false message: type: string description: The same text as `error.message`, for a caller that reads one line. error: $ref: '#/components/schemas/ErrorDetail' Workflow: type: object description: A workflow as the list shows it (without its graph). required: - id - name - status - revision - unpublishedChanges - compositionIds - blockCount - timezone - runsCount - createdAt - updatedAt properties: id: type: string format: uuid name: type: string maxLength: 120 managedUserId: type: string format: uuid nullable: true description: > The customer of a partner (a managed user) this workflow was made for, or null when it is its workspace's own. A customer's editor session lists and opens only the workflows filed under that customer; the partner's own account sees every customer's and tells them apart by this. It is set when the workflow is made and never changes. status: $ref: '#/components/schemas/WorkflowStatus' revision: type: integer minimum: 1 description: >- Rises by one with every save. A save, a publish, a discard and a restore each name the revision they started from. unpublishedChanges: type: boolean description: Whether the draft differs from the live version. compositionIds: type: array items: type: string format: uuid blockCount: type: integer timezone: type: string description: The zone date and time triggers are read in (stored as UTC). runsCount: type: integer description: Visitors who started the workflow, over its whole life. liveVersionId: type: string format: uuid nullable: true createdAt: type: string format: date-time updatedAt: type: string format: date-time firstPublishedAt: type: string format: date-time nullable: true lastPublishedAt: type: string format: date-time nullable: true pausedAt: type: string format: date-time nullable: true archivedAt: type: string format: date-time nullable: true example: id: 3fa85f64-5717-4562-b3fc-2c963f66afa6 name: Example name managedUserId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 status: null revision: 42 unpublishedChanges: true compositionIds: [] blockCount: 42 timezone: Example timezone runsCount: 42 liveVersionId: 3fa85f64-5717-4562-b3fc-2c963f66afa6 createdAt: '2026-01-15T09:30:00.000Z' updatedAt: '2026-01-15T09:30:00.000Z' firstPublishedAt: '2026-01-15T09:30:00.000Z' lastPublishedAt: '2026-01-15T09:30:00.000Z' pausedAt: '2026-01-15T09:30:00.000Z' archivedAt: '2026-01-15T09:30:00.000Z' ErrorDetail: type: object required: - code - message - timestamp properties: code: type: string description: Machine-readable error code. example: RESOURCE_NOT_FOUND message: type: string description: Human-readable explanation. example: Composition not found param: type: string description: The field that caused the error, when one did. example: name docUrl: type: string description: Where this error is explained. suggestedAction: type: string description: What to do about it. retryAfter: type: integer description: >- Seconds to wait before trying again (rate limits). The same number is in the `Retry-After` header. example: 60 details: type: object additionalProperties: true description: >- More about the error: the fields that failed, a limit that was reached. correlationId: type: string description: Quote this when you ask support about the call. example: req_123e4567-e89b-12d3-a456-426614174000 timestamp: type: string format: date-time example: '2026-10-15T10:00:00.000Z' WorkflowStatus: type: string enum: - draft - live - paused - archived description: > `draft`: never published. `live`: visitors get the live version. `paused`: embeds show only their first composition (the live version is kept). `archived`: out of the default list, kept. A workflow can be deleted in any of the four states, with its versions and counts. securitySchemes: apiKeyAuth: type: http scheme: bearer bearerFormat: JWT ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.