Skip to main content
GET
/
apis
/
setting-service
/
public
/
v1
/
forms
List and Filter Forms
curl --request GET \
  --url https://{base-address}/apis/setting-service/public/v1/forms
{
  "Status": "success",
  "Data": {
    "item": {
      "total_count": 123,
      "items": [
        {
          "name": "<string>",
          "display_name": "<string>",
          "description": "<string>",
          "submit_btn_txt": "<string>",
          "is_captcha_enabled": true,
          "created_at": "2023-11-07T05:31:56Z"
        }
      ]
    }
  }
}
Before calling this endpoint, make sure you’ve generated an API token and picked the correct domain. See Authentication & Base URLs.

Query Parameters

​
fields
string
required

Comma-separated list of fields to include in the response

​
locale
string
required

Specifies the language or region for the response data

​
search
string

Search substring to filter forms by display name.

​
sort_by
string

Field to sort results by (e.g. created_at, name).

​
order_by
string

Order pattern (asc for ascending and desc for descending, default is desc)

​
skip
integer

Number of items to skip for pagination offset.

​
rows
integer

Maximum number of forms to return.

Response

A list of forms matching the query and pagination metadata.

​
Status
string

Indicates overall request status.

Example:

"success"

​
Data
object