---
title: "Search Forms"
method: GET
path: "/v1/form/"
tags: ["Forms"]
---

# Search Forms

`GET /v1/form/`

Search for form definitions that match the provided search terms.

Keywords are searched for in the _title_, _description_, _version_, and _identifier_ fields.

## Query parameters

- `form_type_id` integer, nullable
- `user_id` integer, nullable
- `query` string, nullable
- `skip` integer, nullable
- `limit` integer, nullable
- `sort_direction` 'asc' | 'desc' — Direction to sort the `sort_column` - ascending or descending.
- `date_start` string, date-time, nullable
- `date_cut_off` string, date-time, nullable
- `sort_column` 'updated_at' | 'created_at' | 'id' — Which column to sort on

## Response `200`

Successful Response

- ApiGenericListResponseFormSearchModel
  - `error` boolean — A boolean error indicator.
  - `message` string, nullable — Optional message.
  - `data` FormSearchModel[], nullable — The response data for any given request.
    - `id` integer, nullable
    - `title` string, nullable
    - `isSignSubmitted` boolean, nullable
    - `isSignatureRequired` boolean, nullable
    - `isAssetRequired` boolean, nullable
    - `isSiteRequired` boolean, nullable
    - `isEditSubmitted` boolean, nullable
    - `isReviewDraftRequired` boolean, nullable
    - `isReviewRequired` boolean, nullable
    - `isPublished` boolean, nullable
    - `formDraftCount` integer, nullable
    - `formSubmittedCount` integer, nullable
    - `formSignatureCount` integer, nullable
    - `formInstanceCount` integer, nullable
    - `updatedAt` string, date-time, nullable
    - `createdAt` string, date-time, nullable

## Other responses

- `400` — Business Logic Error
- `403` — Permission Error
- `404` — Records Not Found
- `409` — Integrity Error or Data Conflict
- `422` — Validation Error

---

[API](https://skmtc.dev/salussafety/apis/salus-developer-api.md) · [All operations](https://skmtc.dev/salussafety/apis/salus-developer-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/salussafety/salus-developer-api/revisions/ef065f44da25/schema)