Appearance

Forms ​

Get all forms ​

Endpoint: GET https://api.verustrust-forms.com/v1/forms

Parameters(Query) ​

typescript
pageSize?: integer
typescript
pageNumber?: integer
typescript
search: {
}
typescript
sort_by?: string[]

Responses ​

  • 200 OK

application/json

typescript
{
  data: {
    id: string
    name: string
    tenantId: string
    archived: boolean
    permissionsJson?: string
    fields: {
      id: string
      name: string
      type: string
      lookupFormId?: string
      lookupFieldId?: string
      required?: boolean
      isPublic?: boolean
      currentLocation?: boolean
      multipleFiles?: boolean
      default?: string
      options?: string[]
      form:#/components/schemas/FormModel
    }[]
    groupsJson?: string
    entries: {
      id?: string
      tenantId?: string
      date?: string
      form:#/components/schemas/FormModel
      user: {
        id?: string
        token?: string
        firstName?: string
        lastName?: string
        email?: string
        remarks?: string
        role: {
          id: string
          name: string
          permissions: {
            id?: string
            action: {
              id: string
              name: string
              group: string
              type: string
            }
            permit?: boolean
            role:#/components/schemas/RoleModel
            group: {
              id: string
              name: string
              tenantId: string
              users:#/components/schemas/UserModel[]
              permissions:#/components/schemas/PermissionModel[]
            }
            user:#/components/schemas/UserModel
          }[]
          users:#/components/schemas/UserModel[]
        }
        registrationStatus?: string
        tenantId?: string
        accountId?: string
        accountEmail?: string
        groups:#/components/schemas/GroupModel[]
        permissions:#/components/schemas/PermissionModel[]
        created: string
        updated: string
      }
      answers: {
        id?: string
        fieldId?: string
        value?: string
        index?: integer
        entry:#/components/schemas/EntryModel
      }[]
    }[]
  }[]
  pagination: {
    itemCount: integer
    totalPages: integer
    currentPage: integer
    nextPage?: integer
    previousPage?: integer
  }
}

Create a form ​

Endpoint: POST https://api.verustrust-forms.com/v1/forms

RequestBody ​

  • application/json
typescript
{
  name: string
  fields: {
    id?: string
    name?: string
    type?: string
    lookupFormId?: string
    lookupFieldId?: string
    required?: boolean
    isPublic?: boolean
    currentLocation?: boolean
    multipleFiles?: boolean
    options?: string[]
    default?: string
  }[]
  groups: {
    id?: string
    children:#/components/schemas/FieldGroupModel[]
  }[]
}

Responses ​

  • 201 Created

Get a form by id ​

Endpoint: GET https://api.verustrust-forms.com/v1/forms/form/{id}

Responses ​

  • 200 OK

application/json

typescript
{
  id: string
  name: string
  tenantId: string
  archived: boolean
  permissionsJson?: string
  fields: {
    id: string
    name: string
    type: string
    lookupFormId?: string
    lookupFieldId?: string
    required?: boolean
    isPublic?: boolean
    currentLocation?: boolean
    multipleFiles?: boolean
    default?: string
    options?: string[]
    form: {
      id: string
      name: string
      tenantId: string
      archived: boolean
      permissionsJson?: string
      fields:#/components/schemas/FieldModel[]
      groupsJson?: string
      entries: {
        id?: string
        tenantId?: string
        date?: string
        form:#/components/schemas/FormModel
        user: {
          id?: string
          token?: string
          firstName?: string
          lastName?: string
          email?: string
          remarks?: string
          role: {
            id: string
            name: string
            permissions: {
              id?: string
              action: {
                id: string
                name: string
                group: string
                type: string
              }
              permit?: boolean
              role:#/components/schemas/RoleModel
              group: {
                id: string
                name: string
                tenantId: string
                users:#/components/schemas/UserModel[]
                permissions:#/components/schemas/PermissionModel[]
              }
              user:#/components/schemas/UserModel
            }[]
            users:#/components/schemas/UserModel[]
          }
          registrationStatus?: string
          tenantId?: string
          accountId?: string
          accountEmail?: string
          groups:#/components/schemas/GroupModel[]
          permissions:#/components/schemas/PermissionModel[]
          created: string
          updated: string
        }
        answers: {
          id?: string
          fieldId?: string
          value?: string
          index?: integer
          entry:#/components/schemas/EntryModel
        }[]
      }[]
    }
  }[]
  groupsJson?: string
  entries:#/components/schemas/EntryModel[]
}

Update a form ​

Endpoint: PUT https://api.verustrust-forms.com/v1/forms/form/{id}

RequestBody ​

  • application/json
typescript
{
  name?: string
  archived?: boolean
  id?: string
  permissions: {
    users: {
    }
    groups: {
    }
    roles: {
    }
  }
  fields: {
    id?: string
    name?: string
    type?: string
    lookupFormId?: string
    lookupFieldId?: string
    required?: boolean
    isPublic?: boolean
    currentLocation?: boolean
    multipleFiles?: boolean
    options?: string[]
    default?: string
  }[]
  groups: {
    id?: string
    children:#/components/schemas/FieldGroupModel[]
  }[]
}

Responses ​

  • 204 No Content

Delete a form ​

Endpoint: DELETE https://api.verustrust-forms.com/v1/forms/form/{id}

Responses ​

  • 204 No Content