Headers

• Authorization string

  Bearer token used for authorization

  Minimum length is 1.

• X-Correlation-Id string

  Unique identifier to allow referencing a particular transaction or event chain

  Minimum length is 1.

• Accept-Language string

  Returns the requested resources translated according to the passed languages (see translatable resources)

  Minimum length is 1.

Path parameters

• formId string Required

  Minimum length is 1.

Query parameters

• id array[string]

  ID(s) to be considered for filtering

  At least 1 element. Minimum length of each is 1.

• external-id array[string]

  External ID(s) to be considered for filtering

  At least 1 element. Minimum length of each is 1, maximum length of each is 255.

• with-deleted boolean

  Includes deleted resources in the results

Responses

• 200 application/json

  Successful operation

  Hide response attributes Show response attributes object

  • data array[object] Required
    Hide data attributes Show data attributes object

    • id string Required

      Minimum length is 1.

    • form object Required
      Hide form attributes Show form attributes object

      • id string Required

        Minimum length is 1.

      • Additional properties are NOT allowed
    • fetchConfiguration object | null
      Hide fetchConfiguration attributes Show fetchConfiguration attributes object | null

      • id string Required

        Minimum length is 1.

      • Additional properties are NOT allowed
    • order integer Required

      Minimum value is 0.

    • defaultValue string | null

      Minimum length is 1.

    • externalId string | null

      Minimum length is 1, maximum length is 255.

    • targetProperty string | null

      Minimum length is 1.

    • required boolean Required
    • hidden boolean Required
    • inputType string Required

      Values are ADDRESS, BOOLEAN, DATE, DATE_TIME, EMAIL, FETCH, LANGUAGE, LONG_TEXT, MULTI_SELECT, NUMBER, PHONE, SELECT, SHORT_TEXT, TIME_ZONE, or URL.

    • validator object | null
      Hide validator attributes Show validator attributes object | null

      • regex string Required

        A regular expression

        Minimum length is 1.

      • errorMessage object | null Required
        Hide errorMessage attributes Show errorMessage attributes object | null

        • language string Required

          Values are da, de, el, en, es, fr, ja, nl, no, or pl.

        • value string Required
        • Additional properties are NOT allowed
      • Additional properties are NOT allowed
    • label object | null Required
      Hide label attributes Show label attributes object | null

      • language string Required

        Values are da, de, el, en, es, fr, ja, nl, no, or pl.

      • value string Required
      • Additional properties are NOT allowed
    • helpText object | null Required
      Hide helpText attributes Show helpText attributes object | null

      • language string Required

        Values are da, de, el, en, es, fr, ja, nl, no, or pl.

      • value string Required
      • Additional properties are NOT allowed
    • placeholder object | null Required
      Hide placeholder attributes Show placeholder attributes object | null

      • language string Required

        Values are da, de, el, en, es, fr, ja, nl, no, or pl.

      • value string Required
      • Additional properties are NOT allowed
    • createdAt string(date-time) Required

      Minimum length is 1.

    • updatedAt string(date-time) Required

      Minimum length is 1.

    • deletedAt string(date-time) | null Required

      Minimum length is 1.

    • answerOptions array[object] Required
      Hide answerOptions attributes Show answerOptions attributes object

      • externalId string | null

        Minimum length is 1, maximum length is 255.

      • value string | null

        Minimum length is 1, maximum length is 255.

      • label object | null Required
        Hide label attributes Show label attributes object | null

        • language string Required

          Values are da, de, el, en, es, fr, ja, nl, no, or pl.

        • value string Required
        • Additional properties are NOT allowed
      • order integer Required

        Minimum value is 0.

      • createdAt string(date-time) Required

        Minimum length is 1.

      • updatedAt string(date-time) Required

        Minimum length is 1.

      • deletedAt string(date-time) | null Required

        Minimum length is 1.

      • Additional properties are NOT allowed
    • Additional properties are NOT allowed
  • Additional properties are NOT allowed
• 404 application/json

  Resource not found

  Hide response attribute Show response attribute object

  • errors array[object] Required

    At least 1 element.

    Hide errors attributes Show errors attributes object

    • message string Required

      Minimum length is 1.

    • code string Required

      Minimum length is 1.

    • type string Required

      Minimum length is 1.

    • statusCode string Required

      Minimum length is 1.