Get a form

GET
/v1/forms/{id}

A form's settings, with the endpoint it posts to and its hosted_url.

Authorization

bearerAuth
headerAuthorizationBearer <token>

A secret API key from the dashboard: coss_live_… for production environments, coss_test_… for sandbox environments.

Path Parameters

id*string

The form's id.

Header Parameters

Coss-Version?"2026-10-10"

The API version (a date) to use for this request. Defaults to your organization's version, pinned to the latest one when it first used the API and upgraded from the dashboard. The SDK always sends the version it was built for.

Value in"2026-10-10"

Response Body

The form.

application/json
  1. response
object*"form"
Value in"form"
id*string
name*string

Your name for the form, shown in the dashboard and in notifications.

enabled*boolean

false: submissions are refused.

endpoint*string

Where the form posts: <form action=…>.

hosted_url*|

The hosted page, when hosted.enabled; null otherwise.

fields*array<>|

The form's fields. null: any field is accepted, without validation.

strict_fields*boolean

With fields: whether fields the form doesn't define are refused.

allowed_origins*array<string>

Sites that may post to the form. Empty: any.

redirect_url*|

Where browsers go after an HTML post. null: coss.com's thank-you page.

spam*

How submissions are screened.

submitter*

Who the submitter is, and whether they must confirm by email.

notifications*

Emails about accepted submissions.

contacts*

Turning submissions into contacts.

files*

File uploads.

hosted*

The page coss.com can serve for this form.

disabled_by_admin*boolean

coss.com disabled the form for abuse; contact support.

sandbox*boolean

Whether the form belongs to a sandbox environment.

created_at*string
Formatdate-time
updated_at*string
Formatdate-time
import { Coss } from "coss";const coss = new Coss({  apiKey: process.env.COSS_API_KEY,  baseUrl: "https://api.coss.com",});const { data, error } = await coss.forms.get("form_01kd2m8n3p4q5r6s7t8v9w0x1y");
{  "object": "form",  "id": "form_01kd2m8n3p4q5r6s7t8v9w0x1y",  "name": "Contact us",  "enabled": true,  "endpoint": "https://cossforms.com/f/form_01kd2m8n3p4q5r6s7t8v9w0x1y",  "hosted_url": null,  "fields": null,  "strict_fields": false,  "allowed_origins": [    "https://www.example.com"  ],  "redirect_url": null,  "spam": {    "honeypot_field": "_gotcha",    "captcha": "off",    "captcha_site_key": null,    "content_threshold": 0.9,    "on_review": "hold"  },  "submitter": {    "email_field": "email",    "verify": false,    "confirmation_from": null  },  "notifications": {    "recipients": [      "support@example.com"    ],    "from": null  },  "contacts": {    "enabled": false,    "audience_ids": [],    "topics": [],    "double_opt_in": null,    "first_name_field": null,    "last_name_field": null,    "properties": {}  },  "files": {    "enabled": false,    "max_files": 3,    "max_file_bytes": 10485760,    "allowed_types": []  },  "hosted": {    "enabled": false,    "title": null,    "description": null,    "submit_label": null,    "success_message": null,    "published_at": null  },  "disabled_by_admin": false,  "sandbox": false,  "created_at": "2026-10-29T10:00:00.000Z",  "updated_at": "2026-10-29T10:00:00.000Z"}