> ## Documentation Index
> Fetch the complete documentation index at: https://docs.usertick.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Usertick runs surveys on websites, by link, by QR code and by email, and collects every response in one inbox with reports, dashboards and workflows. The REST API lives at https://app.usertick.com/api/public/v1 and uses Bearer API keys or OAuth access tokens; the JavaScript SDK is the @usertick/snippet package on npm.

# Get a workflow

> One workflow with its draft and draftVersion, what runs now (published), what a person must finish before publishing (publishIssues), its warnings and editorUrl.

Scopes: workflows:read.



## OpenAPI

````yaml api-reference/openapi.json GET /workflows/{workflowId}
openapi: 3.1.0
info:
  title: Usertick Public API
  version: 1.0.0
  description: >-
    The Usertick REST API v1: responses, surveys, metrics, contacts, email sends
    and webhook subscriptions of one organization.


    **Authentication.** Send an API key (Settings, Developers, API keys;
    utk_...) or an app's OAuth access token (uto_...) as Authorization: Bearer.
    X-Api-Key works for clients that cannot set Authorization. Each endpoint
    lists the scopes it needs. API keys work on Pro plans and up, and apps such
    as Zapier on every plan. AI assistants reach the API only through the
    Usertick MCP server (Starter and up), never with their token directly.


    **Format.** Plain JSON resources; times are RFC 3339 in UTC with
    milliseconds (2026-09-30T10:00:00.000Z). Lists are { data, nextCursor }:
    limit is 1 to 100 (default 25, out of range is 400), and nextCursor goes
    back as cursor until it is null. A page starts strictly after the last row
    of the page before, so a row deleted or renamed in between never ends a list
    early.


    **Errors.** Every error is { statusCode, success: false, code, message, data
    }, plus errors: [{ field, code, message }] for invalid fields. Switch on
    code (x-error-codes lists them all); messages may change. A path with no
    route answers 404 GEN-000-404, a method the route doesn't take 405
    GEN-000-405 and a body that is not JSON 415 GEN-000-415, in the same
    envelope.


    **Rate limits.** The plan sets the requests a minute, as token buckets: 300
    per credential and 1,500 per organization on Business, 120 and 600 on the
    other plans, and an Enterprise plan may set its own. GET /me returns the
    ones that apply. An answer to an authenticated request has
    X-RateLimit-Limit, -Remaining and -Reset (seconds until the budget is full)
    for the credential, and X-RateLimit-Org-* for the organization, except a 429
    over the credential's budget, which has the credential's only, and
    X-RateLimit-Window: 60s. Over a budget is 429 with Retry-After, the seconds
    the bucket takes to refill one request. A 401 carries no X-RateLimit
    headers, and neither does a 429 GEN-429-001 from the per-address limit
    (3,000 requests a minute per client address, checked before the credential).
    Calls from the Usertick MCP server skip the per-address limit, since every
    assistant arrives from its addresses; the per-credential and
    per-organization budgets still apply to them.


    **Idempotency.** Every POST, and the PATCH of a survey, dashboard or
    workflow draft, takes an Idempotency-Key header: the same key and request
    within 24 hours get the first answer again. A refusal that depends on state
    (a 403, a 409 or a 429) and a server error are not kept, so the same request
    with the key runs again.


    **Survey drafts.** With surveys:draft an assistant or a script creates
    surveys as drafts, copies any survey into a draft and edits the ones never
    published; a person publishes them in Usertick. With surveys:archive it
    archives surveys and restores archived ones as drafts.


    **Contacts and email.** With contacts:read and contacts:write a script
    manages contacts, lists and their members, and erases a contact with every
    response of the person (POST /contacts/{contactId}/erase, with
    responses:delete). With email:read it reads the survey email sends; sending
    stays in Usertick.


    **Dashboards and workflows.** With dashboards:draft an assistant or a script
    creates dashboards as drafts and edits their drafts; with workflows:draft it
    creates workflows switched off and edits their drafts. A person publishes
    either one in Usertick. dashboards:read and workflows:read list and read
    them.


    **Exports.** With exports:create (and responses:read) a script starts CSV or
    Excel exports of a survey's Results or of a dashboard, the files the Export
    menu makes, and downloads them for 24 hours. Each file counts as one of the
    plan's exports a month.


    **Support tickets.** With support:read and support:write an app or an AI
    assistant opens support tickets for the member it signed in as, lists that
    member's tickets and replies on them. A ticket belongs to a person, so an
    API key can't carry these scopes. Support tickets come with the paid plans.


    **Versioning.** Within /v1 changes are additive only: new endpoints, new
    optional parameters, new fields (ignore fields you do not know). Anything
    that will go away is announced at least six months ahead with Deprecation
    and Sunset headers on its answers.


    **Webhooks.** Every delivery is { id, type, createdAt, data }, signed per
    Standard Webhooks (see webhooks). data is the Response resource, with change
    on response.status_changed and response.classification_corrected; on
    theme.spiking it is the spike.


    Every answer carries X-Request-Id.
  contact:
    name: Usertick support
    url: https://usertick.com/support
servers:
  - url: https://app.usertick.com/api/public/v1
    description: Production
security:
  - bearerAuth: []
  - apiKeyHeader: []
tags:
  - name: Account
  - name: Responses
  - name: Surveys
  - name: Metrics
  - name: Exports
  - name: Contacts
  - name: Email
  - name: Dashboards
  - name: Workflows
  - name: Support
  - name: Webhooks
paths:
  /workflows/{workflowId}:
    get:
      tags:
        - Workflows
      summary: Get a workflow
      description: >-
        One workflow with its draft and draftVersion, what runs now (published),
        what a person must finish before publishing (publishIssues), its
        warnings and editorUrl.


        Scopes: workflows:read.
      operationId: getWorkflow
      parameters:
        - name: workflowId
          in: path
          description: A workflow id.
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: The workflow.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
            X-RateLimit-Limit:
              $ref: '#/components/headers/XRateLimitLimit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/XRateLimitRemaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/XRateLimitReset'
            X-RateLimit-Org-Limit:
              $ref: '#/components/headers/XRateLimitOrgLimit'
            X-RateLimit-Org-Remaining:
              $ref: '#/components/headers/XRateLimitOrgRemaining'
            X-RateLimit-Org-Reset:
              $ref: '#/components/headers/XRateLimitOrgReset'
            X-RateLimit-Window:
              $ref: '#/components/headers/XRateLimitWindow'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Workflow'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          description: >-
            The request was refused. Codes: APK-004-004, APK-004-005,
            APK-004-008, APK-004-009, AUTHZ-001-002.
          headers:
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                APK-004-004:
                  $ref: '#/components/examples/APK-004-004'
                APK-004-005:
                  $ref: '#/components/examples/APK-004-005'
                APK-004-008:
                  $ref: '#/components/examples/APK-004-008'
                APK-004-009:
                  $ref: '#/components/examples/APK-004-009'
                AUTHZ-001-002:
                  $ref: '#/components/examples/AUTHZ-001-002'
        '404':
          description: 'The resource couldn''t be found. Codes: PUB-016-001.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                PUB-016-001:
                  $ref: '#/components/examples/PUB-016-001'
        '429':
          $ref: '#/components/responses/TooManyRequests'
components:
  headers:
    XRequestId:
      description: >-
        This answer's id (req_ and 32 hex characters), also in the logs. Quote
        it to support.
      schema:
        type: string
    XRateLimitLimit:
      description: The credential's requests per minute.
      schema:
        type: integer
    XRateLimitRemaining:
      description: What is left of it now.
      schema:
        type: integer
    XRateLimitReset:
      description: >-
        Seconds until the credential's budget is full again (the bucket refills
        continuously).
      schema:
        type: integer
    XRateLimitOrgLimit:
      description: Every credential of the organization together, per minute.
      schema:
        type: integer
    XRateLimitOrgRemaining:
      description: What is left of the organization's budget.
      schema:
        type: integer
    XRateLimitOrgReset:
      description: Seconds until the organization's budget is full again.
      schema:
        type: integer
    XRateLimitWindow:
      description: >-
        The window both budgets count over: 60s, since they are requests per
        minute.
      schema:
        type: string
    RetryAfter:
      description: >-
        Seconds to wait before trying again. On a 429 over a budget, the time
        the bucket takes to refill one request (1 second at 120 or 300 a
        minute); X-RateLimit-Reset says when the whole budget is back.
      schema:
        type: integer
  schemas:
    Workflow:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        status:
          type: string
          enum:
            - draft
            - active
            - disabled
            - paused
        hasUnpublishedChanges:
          type: boolean
          description: The draft holds changes that don't run yet.
        draftVersion:
          type: integer
          description: Send it back as expectedDraftVersion on the next edit.
        draft:
          $ref: '#/components/schemas/WorkflowDraft'
        published:
          oneOf:
            - $ref: '#/components/schemas/WorkflowDraft'
            - type: 'null'
          description: What runs now; null while the workflow was never published.
        pausedReason:
          type:
            - string
            - 'null'
        pausedAt:
          type:
            - string
            - 'null'
          format: date-time
          examples:
            - '2026-09-30T10:00:00.000Z'
        publishIssues:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
              stepId:
                type:
                  - string
                  - 'null'
              field:
                type:
                  - string
                  - 'null'
            required:
              - code
              - stepId
              - field
            additionalProperties: false
          description: >-
            What a person must finish before publishing, each on its step (null
            for the trigger or the whole flow).
        warnings:
          type: array
          items:
            type: object
            properties:
              code:
                type: string
              stepId:
                type:
                  - string
                  - 'null'
              values:
                type: array
                items:
                  type: string
            required:
              - code
              - stepId
              - values
            additionalProperties: false
          description: What publishing allows but the person should see.
        editorUrl:
          type: string
          description: >-
            Opens the workflow editor in Usertick, where a person publishes the
            workflow, which also turns it on.
          format: uri
        draftUpdatedAt:
          type:
            - string
            - 'null'
          format: date-time
          examples:
            - '2026-09-30T10:00:00.000Z'
        createdAt:
          type: string
          format: date-time
          examples:
            - '2026-09-30T10:00:00.000Z'
        updatedAt:
          type:
            - string
            - 'null'
          format: date-time
          examples:
            - '2026-09-30T10:00:00.000Z'
        aiGenerated:
          type: boolean
        aiGeneratedAt:
          type:
            - string
            - 'null'
          description: >-
            When text Usertick AI wrote was first stored here; null when people
            wrote all of it.
          format: date-time
          examples:
            - '2026-09-30T10:00:00.000Z'
      required:
        - id
        - name
        - status
        - hasUnpublishedChanges
        - draftVersion
        - draft
        - published
        - pausedReason
        - pausedAt
        - publishIssues
        - warnings
        - editorUrl
        - draftUpdatedAt
        - createdAt
        - updatedAt
        - aiGenerated
        - aiGeneratedAt
      additionalProperties: false
    Error:
      type: object
      properties:
        statusCode:
          type: integer
          description: The HTTP status, again.
        success:
          type: boolean
          description: Always false.
        code:
          type: string
          description: >-
            What went wrong, stable across versions (see x-error-codes). For
            invalid fields, the first field's code.
          examples:
            - PUB-001-001
        message:
          type:
            - string
            - 'null'
          description: The code's message in English (US); null for a code without one.
        data:
          description: Extra context for some errors; null otherwise.
        errors:
          type: array
          items:
            $ref: '#/components/schemas/FieldError'
          description: >-
            Every invalid field, in the order of the request's parameters. Only
            on a 400 about fields.
      required:
        - statusCode
        - success
        - code
        - message
        - data
      description: >-
        Every error answer. Success answers are the plain resource or list
        instead.
      additionalProperties: false
      examples:
        - statusCode: 400
          success: false
          code: PUB-001-001
          message: The limit must be between 1 and 100.
          data: null
          errors:
            - field: limit
              code: PUB-001-001
              message: The limit must be between 1 and 100.
            - field: sort
              code: PUB-001-005
              message: The sort order must be asc or desc.
    WorkflowDraft:
      type: object
      properties:
        trigger:
          $ref: '#/components/schemas/WorkflowTrigger'
        steps:
          type: array
          items:
            $ref: '#/components/schemas/WorkflowStep'
          maxItems: 200
        wires:
          type: array
          items:
            $ref: '#/components/schemas/WorkflowWire'
          maxItems: 600
      required:
        - trigger
      description: The workflow as its editor holds it, at most 512 KB stored.
      additionalProperties: false
      examples:
        - trigger:
            event: response.analyzed
            surveyIds:
              - 11111111-1111-4111-8111-111111111111
            match: all
            conditions:
              - field: ai.type
                op: in
                value:
                  - bug
          steps:
            - id: s1
              kind: action
              action: slack.post_message
              params:
                text: 'New bug report: {{response.text}}'
          wires:
            - from: trigger
              port: out
              to: s1
    FieldError:
      type: object
      properties:
        field:
          type: string
          description: >-
            The query parameter, or the body property (camelCase, dotted when
            nested).
        code:
          type: string
        message:
          type:
            - string
            - 'null'
      required:
        - field
        - code
        - message
      additionalProperties: false
    WorkflowTrigger:
      type: object
      properties:
        event:
          type: string
          description: What starts the workflow.
          enum:
            - response.created
            - response.analyzed
            - response.urgent
            - metric.threshold
        alert:
          oneOf:
            - $ref: '#/components/schemas/WorkflowAlert'
            - type: 'null'
        surveyIds:
          type: array
          items:
            type: string
            format: uuid
          description: >-
            The one survey the workflow belongs to, as a list of one; empty
            while none is chosen. A survey the credential can't read is 404
            APK-006-005.
          maxItems: 1
        match:
          type: string
          enum:
            - all
            - any
        conditions:
          type: array
          items:
            $ref: '#/components/schemas/WorkflowCondition'
          maxItems: 50
        x:
          type: number
        'y':
          type: number
      required:
        - event
      additionalProperties: false
    WorkflowStep:
      type: object
      properties:
        id:
          type: string
          description: Unique in the draft; "trigger" is the trigger's.
          maxLength: 64
        kind:
          type: string
          enum:
            - action
            - branch
            - wait
        x:
          type: number
          description: >-
            Its place on the canvas. When no step and not the trigger names one,
            Usertick arranges the flow as the editor's Tidy up does.
        'y':
          type: number
        action:
          type:
            - string
            - 'null'
          description: >-
            An action key (GET /workflows/capabilities); an unknown one is 400
            PUB-001-004, one the plan lacks 403 PLN-002-001.
          maxLength: 100
        connectionId:
          type:
            - string
            - 'null'
          description: >-
            A connection of the action's tool; one the organization can't send
            with is 400 PUB-016-002. Left out, a person picks it.
          maxLength: 64
        params:
          type: object
          description: >-
            The action's inputs, each a string or a boolean, at most 32 KB in
            all.
        match:
          type: string
          enum:
            - all
            - any
        conditions:
          type: array
          items:
            $ref: '#/components/schemas/WorkflowCondition'
          description: A branch's conditions.
          maxItems: 50
        waitSeconds:
          type:
            - integer
            - 'null'
          description: A wait's seconds, 60 to 2,592,000 to publish.
        aiGenerated:
          type:
            - boolean
            - 'null'
          description: >-
            Output only: Usertick AI drafted the step. The API never marks a
            step it writes.
        aiGeneratedAt:
          type:
            - string
            - 'null'
          description: >-
            When text Usertick AI wrote was first stored here; null when people
            wrote all of it.
          format: date-time
          examples:
            - '2026-09-30T10:00:00.000Z'
      required:
        - id
        - kind
      additionalProperties: false
    WorkflowWire:
      type: object
      properties:
        from:
          type: string
          description: A step id, or "trigger".
          maxLength: 64
        port:
          type: string
          description: out, or yes and no from a branch.
          maxLength: 32
        to:
          type: string
          maxLength: 64
      required:
        - from
        - port
        - to
      additionalProperties: false
    WorkflowAlert:
      type: object
      properties:
        metric:
          type:
            - string
            - 'null'
          description: nps, avg_score, detractors, responses, urgent or type.
          maxLength: 32
        questionId:
          type:
            - string
            - 'null'
          maxLength: 64
        feedbackType:
          type:
            - string
            - 'null'
          description: bug, idea, complaint, question or praise, for the type metric.
          maxLength: 32
        window:
          type:
            - string
            - 'null'
          description: 1h, 24h, 7d or 30d.
          maxLength: 8
        direction:
          type:
            - string
            - 'null'
          description: below or above.
          maxLength: 8
        value:
          type:
            - number
            - 'null'
          description: The line.
        cooldown:
          type:
            - string
            - 'null'
          description: 1h, 6h, 24h or 7d.
          maxLength: 8
        notifyRecovery:
          type: boolean
          description: Start once more when the number is back on the right side.
      required: []
      description: >-
        An alarm (metric.threshold). Any member may be missing while the draft
        is drawn; publishIssues says what a person must finish.
      additionalProperties: false
    WorkflowCondition:
      type: object
      properties:
        field:
          type: string
          description: A condition field (GET /workflows/capabilities lists them).
          maxLength: 200
        op:
          type: string
          maxLength: 32
        value:
          description: >-
            A string, a number, a list of strings, or null for answered and
            not_answered.
      required:
        - field
        - op
      additionalProperties: false
  responses:
    Unauthorized:
      description: >-
        No credential, one that is invalid, expired or revoked, or a token an AI
        assistant got for the MCP server. Codes: APK-004-001, APK-004-002,
        APK-004-007.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/XRequestId'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            APK-004-001:
              $ref: '#/components/examples/APK-004-001'
            APK-004-002:
              $ref: '#/components/examples/APK-004-002'
            APK-004-007:
              $ref: '#/components/examples/APK-004-007'
    TooManyRequests:
      description: >-
        Over the credential's or the organization's budget, or over the
        per-address limit that is checked before the credential (GEN-429-001,
        without X-RateLimit headers). Codes: APK-004-003, APK-004-006,
        GEN-429-001.
      headers:
        X-Request-Id:
          $ref: '#/components/headers/XRequestId'
        Retry-After:
          $ref: '#/components/headers/RetryAfter'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            APK-004-003:
              $ref: '#/components/examples/APK-004-003'
            APK-004-006:
              $ref: '#/components/examples/APK-004-006'
            GEN-429-001:
              $ref: '#/components/examples/GEN-429-001'
  examples:
    APK-004-004:
      summary: >-
        This API key or app doesn't have permission for this request. Grant it
        the required scope.
      value:
        statusCode: 403
        success: false
        code: APK-004-004
        message: >-
          This API key or app doesn't have permission for this request. Grant it
          the required scope.
        data: null
    APK-004-005:
      summary: >-
        Your plan doesn't include API keys. To use them, upgrade to Pro or
        higher.
      value:
        statusCode: 403
        success: false
        code: APK-004-005
        message: >-
          Your plan doesn't include API keys. To use them, upgrade to Pro or
          higher.
        data: null
    APK-004-008:
      summary: >-
        This organization's plan doesn't include apps that use the API, such as
        Zapier. To use them, contact Usertick sales to change the plan.
      value:
        statusCode: 403
        success: false
        code: APK-004-008
        message: >-
          This organization's plan doesn't include apps that use the API, such
          as Zapier. To use them, contact Usertick sales to change the plan.
        data: null
    APK-004-009:
      summary: >-
        This organization's plan doesn't include the MCP server. To use an AI
        assistant with Usertick, upgrade to Starter or higher.
      value:
        statusCode: 403
        success: false
        code: APK-004-009
        message: >-
          This organization's plan doesn't include the MCP server. To use an AI
          assistant with Usertick, upgrade to Starter or higher.
        data: null
    AUTHZ-001-002:
      summary: Your role doesn't have the required permission.
      value:
        statusCode: 403
        success: false
        code: AUTHZ-001-002
        message: Your role doesn't have the required permission.
        data: null
    PUB-016-001:
      summary: The workflow couldn't be found.
      value:
        statusCode: 404
        success: false
        code: PUB-016-001
        message: The workflow couldn't be found.
        data: null
    APK-004-001:
      summary: Send an API key or an access token in the Authorization header.
      value:
        statusCode: 401
        success: false
        code: APK-004-001
        message: Send an API key or an access token in the Authorization header.
        data: null
    APK-004-002:
      summary: >-
        The API key or access token is invalid, expired or revoked. Connect
        again with a valid one.
      value:
        statusCode: 401
        success: false
        code: APK-004-002
        message: >-
          The API key or access token is invalid, expired or revoked. Connect
          again with a valid one.
        data: null
    APK-004-007:
      summary: >-
        This credential is for another server. The MCP server takes only the
        access tokens an assistant gets when it signs in, and the REST API takes
        API keys and app tokens.
      value:
        statusCode: 401
        success: false
        code: APK-004-007
        message: >-
          This credential is for another server. The MCP server takes only the
          access tokens an assistant gets when it signs in, and the REST API
          takes API keys and app tokens.
        data: null
    APK-004-003:
      summary: This API key or app sent too many requests. Wait a minute and try again.
      value:
        statusCode: 429
        success: false
        code: APK-004-003
        message: >-
          This API key or app sent too many requests. Wait a minute and try
          again.
        data: null
    APK-004-006:
      summary: >-
        Your organization sent too many API requests. Wait a minute and try
        again.
      value:
        statusCode: 429
        success: false
        code: APK-004-006
        message: >-
          Your organization sent too many API requests. Wait a minute and try
          again.
        data: null
    GEN-429-001:
      summary: Too many requests were sent. Wait a minute and try again.
      value:
        statusCode: 429
        success: false
        code: GEN-429-001
        message: Too many requests were sent. Wait a minute and try again.
        data: null
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: An API key (utk_live_...) or an app's OAuth access token (uto_...).
    apiKeyHeader:
      type: apiKey
      in: header
      name: X-Api-Key
      description: The API key, for clients that cannot send Authorization.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.