> ## 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 survey draft

> A survey in the typed shape with its draft revision (draftVersion), its editor link (editorUrl) and what publishing would refuse now (publishChecks). Any status: editable is true only for a survey in draft status, the one kind the API edits. A question that holds settings the typed shape doesn't show says extraSettings: true, and an edit keeps them.

Scopes: surveys:read.



## OpenAPI

````yaml api-reference/openapi.json GET /surveys/{surveyId}/draft
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:
  /surveys/{surveyId}/draft:
    get:
      tags:
        - Surveys
      summary: Get a survey draft
      description: >-
        A survey in the typed shape with its draft revision (draftVersion), its
        editor link (editorUrl) and what publishing would refuse now
        (publishChecks). Any status: editable is true only for a survey in draft
        status, the one kind the API edits. A question that holds settings the
        typed shape doesn't show says extraSettings: true, and an edit keeps
        them.


        Scopes: surveys:read.
      operationId: getSurveyDraft
      parameters:
        - name: surveyId
          in: path
          description: A survey id.
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: The draft.
          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/SurveyDraft'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: 'The resource couldn''t be found. Codes: APK-006-005.'
          headers:
            X-Request-Id:
              $ref: '#/components/headers/XRequestId'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                APK-006-005:
                  $ref: '#/components/examples/APK-006-005'
        '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:
    SurveyDraft:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        status:
          type: string
          enum:
            - draft
            - active
            - paused
            - archived
        channel:
          type: string
          enum:
            - website
            - link
            - email
        site:
          oneOf:
            - $ref: '#/components/schemas/SiteRef'
            - type: 'null'
        draftVersion:
          type: integer
          description: Send it back as expectedDraftVersion.
        editable:
          type: boolean
          description: 'True only for a survey in draft status: the API edits nothing else.'
        editorUrl:
          type: string
          description: >-
            The survey in the Usertick editor, where a person publishes it. Give
            it to the person.
          format: uri
        defaultLanguage:
          type: string
        languages:
          type: array
          items:
            type: string
        displayMode:
          type: string
          enum:
            - steps
            - all
            - chat
        position:
          type: string
        texts:
          type: object
          additionalProperties:
            description: >-
              A string in the survey's default language, or a map of language to
              text (languages the survey has). On an edit a string replaces the
              field and its translations; a map sets those languages and keeps
              the others, null removing one.
            oneOf:
              - type: string
              - type: object
                additionalProperties:
                  type:
                    - string
                    - 'null'
        targeting:
          $ref: '#/components/schemas/DraftTargeting'
        questions:
          type: array
          items:
            $ref: '#/components/schemas/DraftQuestion'
        publishChecks:
          type: array
          items:
            $ref: '#/components/schemas/PublishCheck'
          description: >-
            What publishing would refuse now: a report for the person who
            publishes. Nothing here blocks saving a draft.
        createdAt:
          type: string
          format: date-time
          examples:
            - '2026-09-30T10:00:00.000Z'
        updatedAt:
          type: string
          format: date-time
          examples:
            - '2026-09-30T10:00:00.000Z'
        aiGenerated:
          type: boolean
          description: >-
            True when Usertick AI wrote text in the survey's own fields; each
            question has its own. Read only.
        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
        - channel
        - site
        - draftVersion
        - editable
        - editorUrl
        - defaultLanguage
        - languages
        - displayMode
        - position
        - texts
        - targeting
        - questions
        - publishChecks
        - createdAt
        - updatedAt
        - aiGenerated
        - aiGeneratedAt
      additionalProperties: false
      examples:
        - id: 11111111-1111-4111-8111-111111111111
          name: Checkout NPS
          status: draft
          channel: website
          site:
            id: 22222222-2222-4222-8222-222222222222
            domain: shop.example.com
          draftVersion: 1
          editable: true
          editorUrl: >-
            https://app.usertick.com/surveys?edit=11111111-1111-4111-8111-111111111111&org=3c9e4e1a-5b7d-4f20-9a61-0c2d8e4f6a10
          defaultLanguage: en
          languages:
            - en
          displayMode: steps
          position: bottom-right
          texts: {}
          targeting:
            pages: null
            trigger:
              type: delay
              seconds: 5
            devices:
              - desktop
              - tablet
              - mobile
            frequency:
              type: until_response
              cooldownDays: 30
              maxDisplays: 0
              afterDismissDays: 0
            extraSettings: false
          questions:
            - id: a0000000-0000-4000-8000-000000000005
              ref: q1
              type: nps
              text: How likely are you to recommend Usertick?
              required: true
              lowLabel: Not likely
              highLabel: Very likely
              logic: []
              aiGenerated: false
              aiGeneratedAt: null
          publishChecks: []
          createdAt: '2026-11-03T10:00:00.000Z'
          updatedAt: '2026-11-03T10:00:00.000Z'
          aiGenerated: false
          aiGeneratedAt: null
    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.
    SiteRef:
      type: object
      properties:
        id:
          type: string
          format: uuid
        domain:
          type: string
      required:
        - id
        - domain
      additionalProperties: false
    DraftTargeting:
      type: object
      properties:
        pages:
          oneOf:
            - type: object
              properties:
                target:
                  type: string
                  enum:
                    - path
                    - url
                include:
                  type: array
                  items:
                    $ref: '#/components/schemas/DraftPageRule'
                exclude:
                  type: array
                  items:
                    $ref: '#/components/schemas/DraftPageRule'
              required:
                - target
                - include
                - exclude
              additionalProperties: false
            - type: 'null'
          description: Null for every page.
        trigger:
          oneOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - load
                    - delay
                    - scroll
                    - exit_intent
                    - time_on_site
                seconds:
                  type: integer
                  description: delay and time_on_site only; left out for the other types.
                percent:
                  type: integer
                  description: scroll only; left out for the other types.
              required:
                - type
              additionalProperties: false
            - type: 'null'
          description: Null for none, or for a trigger outside this subset (extraSettings).
        devices:
          type: array
          items:
            type: string
            enum:
              - desktop
              - tablet
              - mobile
        frequency:
          type: object
          properties:
            type:
              type: string
              enum:
                - once
                - until_response
                - cooldown
                - always
            cooldownDays:
              type: integer
            maxDisplays:
              type: integer
            afterDismissDays:
              type: integer
          required:
            - type
            - cooldownDays
            - maxDisplays
            - afterDismissDays
          additionalProperties: false
        extraSettings:
          type: boolean
          description: >-
            The survey holds targeting this subset doesn't show (an advanced
            trigger, audience rules); an edit keeps it unless it sets that part.
      required:
        - pages
        - trigger
        - devices
        - frequency
        - extraSettings
      additionalProperties: false
    DraftQuestion:
      type: object
      properties:
        id:
          type: string
          description: The question id.
        ref:
          type: string
          description: 'On a question this request added: your ref.'
        type:
          type: string
          description: >-
            File upload, screenshot and signature questions are added in the
            dashboard (400 PUB-008-006). A type never changes.
          enum:
            - welcome
            - nps
            - rating
            - ces
            - emoji
            - boolean
            - multiple_choice
            - dropdown
            - ranking
            - slider
            - text
            - contact
            - date
            - matrix
            - number
            - big_scale
            - ruler
            - dial
            - this_or_that
            - allocation
            - consent
            - cta
        text:
          description: >-
            The question (a message screen's heading). Required on a create. A
            string in the survey's default language, or a map of language to
            text (languages the survey has). On an edit a string replaces the
            field and its translations; a map sets those languages and keeps the
            others, null removing one.
          oneOf:
            - type: string
            - type: object
              additionalProperties:
                type:
                  - string
                  - 'null'
        description:
          description: Words under the question.
          oneOf:
            - type: string
            - type: object
              additionalProperties:
                type:
                  - string
                  - 'null'
            - type: 'null'
        required:
          type: boolean
          description: >-
            The editor's default for the type when left out (requiredByDefault).
            A message screen and a call to action can't be required.
        title:
          description: 'welcome: the heading.'
          oneOf:
            - type: string
            - type: object
              additionalProperties:
                type:
                  - string
                  - 'null'
            - type: 'null'
        body:
          description: 'welcome, cta: one paragraph.'
          oneOf:
            - type: string
            - type: object
              additionalProperties:
                type:
                  - string
                  - 'null'
            - type: 'null'
        buttonText:
          description: welcome, cta.
          oneOf:
            - type: string
            - type: object
              additionalProperties:
                type:
                  - string
                  - 'null'
            - type: 'null'
        buttonUrl:
          type:
            - string
            - 'null'
          description: 'cta: the link (https); publishing needs one.'
          maxLength: 2048
        options:
          type: array
          items:
            description: >-
              A string in the survey's default language, or a map of language to
              text (languages the survey has). On an edit a string replaces the
              field and its translations; a map sets those languages and keeps
              the others, null removing one.
            oneOf:
              - type: string
              - type: object
                additionalProperties:
                  type:
                    - string
                    - 'null'
          description: >-
            multiple_choice, dropdown, ranking, allocation. Replaces the list;
            an option whose words stay keeps its value.
          maxItems: 250
        multiple:
          type: boolean
          description: 'multiple_choice, dropdown, matrix: more than one answer.'
        allowOther:
          type: boolean
          description: 'multiple_choice, dropdown: an Other answer.'
        faces:
          oneOf:
            - type: array
              items:
                type: object
                properties:
                  emoji:
                    type: string
                    maxLength: 16
                  label:
                    description: >-
                      A string in the survey's default language, or a map of
                      language to text (languages the survey has). On an edit a
                      string replaces the field and its translations; a map sets
                      those languages and keeps the others, null removing one.
                    oneOf:
                      - type: string
                      - type: object
                        additionalProperties:
                          type:
                            - string
                            - 'null'
                      - type: 'null'
                required:
                  - emoji
                additionalProperties: false
              maxItems: 7
            - type: 'null'
          description: >-
            emoji, dial: worst to best. On a dial without lowLabel and highLabel
            the first and last faces' words are the ends; an emoji scale shows
            no ends.
        rows:
          type: array
          items:
            description: >-
              A string in the survey's default language, or a map of language to
              text (languages the survey has). On an edit a string replaces the
              field and its translations; a map sets those languages and keeps
              the others, null removing one.
            oneOf:
              - type: string
              - type: object
                additionalProperties:
                  type:
                    - string
                    - 'null'
          description: 'matrix: the statements.'
          maxItems: 50
        columns:
          type: array
          items:
            description: >-
              A string in the survey's default language, or a map of language to
              text (languages the survey has). On an edit a string replaces the
              field and its translations; a map sets those languages and keeps
              the others, null removing one.
            oneOf:
              - type: string
              - type: object
                additionalProperties:
                  type:
                    - string
                    - 'null'
          description: 'matrix: the answers.'
          maxItems: 20
        pairs:
          type: array
          items:
            type: object
            properties:
              a:
                description: >-
                  A string in the survey's default language, or a map of
                  language to text (languages the survey has). On an edit a
                  string replaces the field and its translations; a map sets
                  those languages and keeps the others, null removing one.
                oneOf:
                  - type: string
                  - type: object
                    additionalProperties:
                      type:
                        - string
                        - 'null'
              b:
                description: >-
                  A string in the survey's default language, or a map of
                  language to text (languages the survey has). On an edit a
                  string replaces the field and its translations; a map sets
                  those languages and keeps the others, null removing one.
                oneOf:
                  - type: string
                  - type: object
                    additionalProperties:
                      type:
                        - string
                        - 'null'
            required:
              - a
              - b
            additionalProperties: false
          description: this_or_that.
          maxItems: 50
        points:
          type:
            - integer
            - 'null'
          description: 'rating: how many points (2 to 10, default 5).'
          minimum: 2
          maximum: 10
        min:
          type:
            - number
            - 'null'
          description: slider, big_scale, ruler, number.
        max:
          type:
            - number
            - 'null'
          description: slider, big_scale, ruler, number.
        step:
          type:
            - number
            - 'null'
          description: slider, ruler, number; allocation 1 to 100.
        lowLabel:
          description: 'The low end: nps, rating, ces, dial, slider, big_scale, ruler.'
          oneOf:
            - type: string
            - type: object
              additionalProperties:
                type:
                  - string
                  - 'null'
            - type: 'null'
        highLabel:
          description: The high end.
          oneOf:
            - type: string
            - type: object
              additionalProperties:
                type:
                  - string
                  - 'null'
            - type: 'null'
        placeholder:
          description: text, number, dropdown.
          oneOf:
            - type: string
            - type: object
              additionalProperties:
                type:
                  - string
                  - 'null'
            - type: 'null'
        dateMode:
          type: string
          description: date.
          enum:
            - date
            - datetime-local
            - time
        contactFields:
          type: array
          items:
            type: string
            enum:
              - name
              - email
              - phone
              - company
              - message
          description: >-
            contact (default name and email). Required through the email field,
            else the first.
          maxItems: 5
        yesLabel:
          description: boolean.
          oneOf:
            - type: string
            - type: object
              additionalProperties:
                type:
                  - string
                  - 'null'
            - type: 'null'
        noLabel:
          description: boolean.
          oneOf:
            - type: string
            - type: object
              additionalProperties:
                type:
                  - string
                  - 'null'
            - type: 'null'
        checkboxLabel:
          description: 'consent: the words beside the box.'
          oneOf:
            - type: string
            - type: object
              additionalProperties:
                type:
                  - string
                  - 'null'
            - type: 'null'
        logic:
          type: array
          items:
            type: object
            properties:
              op:
                type: string
                enum:
                  - equals
                  - not_equals
                  - contains
                  - not_contains
                  - gt
                  - gte
                  - lt
                  - lte
                  - answered
                  - not_answered
              answer:
                type:
                  - string
                  - number
                  - boolean
              then:
                oneOf:
                  - type: string
                    enum:
                      - end
                  - type: object
                    properties:
                      goto:
                        type: string
                        description: A question id.
                    required:
                      - goto
                    additionalProperties: false
                  - type: 'null'
                description: >-
                  Null for a rule with no destination yet (publishing asks for
                  one).
            required:
              - op
              - then
            additionalProperties: false
          description: Not on a message screen.
        extraSettings:
          type: boolean
          description: >-
            Only when true: the question holds settings this shape doesn't show
            (a picture, a timer, a page); an edit keeps them.
        aiGenerated:
          type: boolean
          description: >-
            True when Usertick AI wrote text in this question, in any of its
            languages: a draft from Create with AI, a generated or suggested
            question, suggested options or labels, a rewrite or a translation.
            The mark records where the text came from, so it stays true after a
            person edits the text. Read only: an edit never sends it.
        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
        - type
        - text
        - required
        - aiGenerated
        - aiGeneratedAt
      description: >-
        A question in the typed shape: the common fields and the type's own that
        it holds.
      additionalProperties: false
    PublishCheck:
      type: object
      properties:
        code:
          type: string
          description: The code publishing answers with.
        message:
          type:
            - string
            - 'null'
      required:
        - code
        - message
      additionalProperties: false
    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
    DraftPageRule:
      type: object
      properties:
        op:
          type: string
          enum:
            - contains
            - equals
            - starts_with
            - ends_with
            - regex
        value:
          type: string
        target:
          type: string
          enum:
            - path
            - url
      required:
        - op
        - value
      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'
    Forbidden:
      description: >-
        The credential lacks a scope this endpoint needs, the plan does not
        include the API (API keys on Pro and up; apps such as Zapier on every
        plan, unless a custom plan leaves them out; AI assistants through the
        Usertick MCP server on Starter and up), or the member an app or an
        assistant acts as lacks the permission (AUTHZ-001-002; AUTHZ-001-001
        when the check names no reason). Codes: APK-004-004, APK-004-005,
        APK-004-008, APK-004-009, AUTHZ-001-001, 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-001:
              $ref: '#/components/examples/AUTHZ-001-001'
            AUTHZ-001-002:
              $ref: '#/components/examples/AUTHZ-001-002'
    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-006-005:
      summary: The survey couldn't be found.
      value:
        statusCode: 404
        success: false
        code: APK-006-005
        message: The survey 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-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-001:
      summary: You aren't a member of this organization.
      value:
        statusCode: 403
        success: false
        code: AUTHZ-001-001
        message: You aren't a member of this organization.
        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
    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.