Basker Docs

List Forms

Retrieve form definitions, including fields, settings, and confirmation behavior. Visitor submissions are not returned. Rate limit: 100 requests per minute per API key.

GET
/{version}/{tenant}/forms
Authorization<token>

Use format: users API-Key YOUR_API_KEY

In: header

Path Parameters

version*string

API version

Default"2026-02"
Value in"2026-02"
tenant*string

Tenant slug

Query Parameters

limit?integer

Number of items to return

Default10
page?integer

Page number

Default1
sort?string

Sort field (prefix with - for descending)

where?

Query filters

select?

Field selection object. Example query: select[slug]=true&select[updatedAt]=true

populate?

Relationship population object. Example query: populate[media][url]=true

depth?integer

Relationship population depth.

Range0 <= value
locale?string

Content locale, or all to return every locale.

fallbackLocale?string

Locale to use when the requested locale has no value.

draft?boolean

When true, read or write the draft version.

Defaultfalse
joins?

Controls pagination, sorting, filtering, and counts for joined fields.

pagination?boolean

Set false to return every matching record without page-based pagination.

Defaulttrue
attributeWhere?

Filters configured custom attributes by public key and operator.

whereOperators?

Advanced where-operator options.

Response Body

application/json

application/json

curl -X GET "https://api.basker.app/partners/2026-02/string/forms?select%5Bslug%5D=true&select%5BupdatedAt%5D=true&populate%5Bmedia%5D=%5Bobject+Object%5D"
{
  "docs": [
    {
      "confirmationMessage": "string",
      "confirmationType": "message",
      "fields": [
        {}
      ],
      "redirect": {
        "type": "reference",
        "reference": "string",
        "url": "string"
      },
      "slug": "string",
      "submitButtonLabel": "string",
      "tenant": "string",
      "title": "string"
    }
  ],
  "totalDocs": 0,
  "limit": 0,
  "totalPages": 0,
  "page": 0,
  "pagingCounter": 0,
  "hasPrevPage": true,
  "hasNextPage": true,
  "prevPage": 0,
  "nextPage": 0
}
{
  "error": "Too Many Requests",
  "message": "Rate limit exceeded. Please retry later."
}