GetForms: Get info of all forms.

In RColetum: Access your Coletum's Data from API

Get info of all forms.

Description

Retrieve information about all forms in the account.

Usage

GetForms(
  token,
  status = NULL,
  name = NULL,
  page = 1,
  page_size = 100,
  all_pages = TRUE
)

Arguments

token	String access token.
status	Optional filter. State of the form: "enabled" or "disabled".
name	Optional filter. Returns forms whose name contains this string (partial match, case-insensitive).
page	Integer. Starting page when all_pages = FALSE. Default: 1.
page_size	Integer. Number of records per API request (max 500). Default: 100.
all_pages	Logical. If TRUE (default), fetches all pages automatically and returns a combined data frame. If FALSE, returns only the page specified by page.

Details

To get more details about the fields provided by the result, please visit the API documentation.

Value

A data frame with columns: id, name, description, status, category, version, public_answers. Returns NULL with a warning if no forms are found.

Examples

GetForms("cizio7xeohwgc8k4g4koo008kkoocwg")
GetForms("cizio7xeohwgc8k4g4koo008kkoocwg", status = "enabled")
GetForms("cizio7xeohwgc8k4g4koo008kkoocwg", name = "Iris")
GetForms("cizio7xeohwgc8k4g4koo008kkoocwg", page_size = 3, all_pages = FALSE)

RColetum documentation built on April 17, 2026, 1:07 a.m.