---
title: "Fetch form definition list."
method: GET
path: "/custom_form_definition/fetch"
tags: ["Documents|Form definition"]
---

# Fetch form definition list.

`GET /custom_form_definition/fetch`

This endpoint enables you to retrieve form definitions. This includes the document name, version, creation date,
and last update date. Additionally, you can set an offset and a limit. The default limit and maximum limit are
both set at 100.

## Query parameters

- `filter[byIds][]` integer[]
- `filter[byText]` string
- `filter[byExternalReference]` string
- `offset` integer
- `limit` integer

## Response `200`

Success Response:

- StandardCustomFormDefinitionFetchResponse
  - `data` object[] — The form definitions.
    - `id` integer — The internal ID.
    - `name` string — Name of the form definition.
    - `version` integer — Version of the form definition.
    - `createdAt` string — Represents a date and a time. (ISO 8601) ICU-Format: yyyy-MM-dd'T'HH:mm:ssxxx
    - `updatedAt` string — Represents a date and a time. (ISO 8601) ICU-Format: yyyy-MM-dd'T'HH:mm:ssxxx
    - `externalReference` string — The external reference of the form definition.
  - `offset` integer — Use this parameter to specify the number of records you want to skip before starting to collect the data from the result set.
  - `totalCount` integer — Total number of available form definitions. (Only calculated if offset is 0)

---

[API](https://skmtc.net/geocapture/apis/geocapture-api.md) · [All operations](https://skmtc.net/geocapture/apis/geocapture-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/geocapture/geocapture-api/versions/15839b24c497/schema)