Skip to main content
GET
/
api
/
v1
/
form
/
{form_id}
Get Form By Id
curl --request GET \
  --url 'https://api.example.com/api/v1/form/{form_id}?api_key='
{
  "message": "Data retrieved successfully",
  "meta": {},
  "data": {
    "name": "<string>",
    "trigger_instructions": "<string>",
    "form_type": "natural",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "attributes": {},
    "fields": [],
    "webhook_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "trigger_tools": [],
    "contact_mapping": {}
  }
}

Authorizations

api_key
string
query
required

Your API key for authentication. You can generate it from the Settings page. Format: starts with in-.

Path Parameters

form_id
string<uuid>
required

Response

Successful Response

message
string | null
default:Data retrieved successfully
meta
Meta · object
data
IFormRead · object