Forms
Site Resources · 2 endpoints
GET
/v1/formsList Forms
app_install_bearerscope: forms:read
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
statusquery | string | optional | draft, active, paused, archived |
typequery | string | optional | contact, hiring, partner, survey, quiz, questionnaire, booking_intake, contract, custom |
access_typequery | string | optional | public, authenticated, invite_only |
limitquery | integer | optional | |
starting_afterquery | string | optional | |
ending_beforequery | string | optional |
Returns · 200
| Field | Type | Required | Description |
|---|---|---|---|
data | FormListResponse | required | |
data.has_more | boolean | required | |
data.items | FormObject[] | required | |
data.items[].access_type | string | required | public, authenticated, invite_only |
data.items[].created_at | string | optional | |
data.items[].description | string | optional | |
data.items[].domain_ids | string[] | optional | |
data.items[].id | string | required | |
data.items[].name | string | required | |
data.items[].object | string | optional | form |
data.items[].published_at | string | optional | |
data.items[].published_version | integer | optional | |
data.items[].requires_login | boolean | optional | |
data.items[].route_path | string | optional | |
data.items[].schema | object | optional | |
data.items[].slug | string | required | |
data.items[].status | string | required | draft, active, paused, archived |
data.items[].style_overrides | object | optional | |
data.items[].total_submissions | integer | optional | |
data.items[].total_views | integer | optional | |
data.items[].type | string | required | contact, hiring, partner, survey, quiz, questionnaire, booking_intake, contract, custom |
data.items[].updated_at | string | optional | |
data.items[].version | integer | optional | |
data.items[].website_ids | string[] | optional | |
data.next_cursor | string | optional | |
data.object | string | optional | list |
data.url | string | optional | |
success | boolean | required | true |
Errors 400401403404409422429500
curl https://api.getmeonline.io/v1/forms \
-H "Authorization: Bearer $GETME_API_KEY"GET
/v1/forms/{form_id}Get Form
app_install_bearerscope: forms:read
Parameters
| Field | Type | Required | Description |
|---|---|---|---|
form_idpath | string | required | Form public identifier in form_<21 Base62> format. |
Returns · 200
| Field | Type | Required | Description |
|---|---|---|---|
data | FormObject | required | |
data.access_type | string | required | public, authenticated, invite_only |
data.created_at | string | optional | |
data.description | string | optional | |
data.domain_ids | string[] | optional | |
data.id | string | required | |
data.name | string | required | |
data.object | string | optional | form |
data.published_at | string | optional | |
data.published_version | integer | optional | |
data.requires_login | boolean | optional | |
data.route_path | string | optional | |
data.schema | object | optional | |
data.slug | string | required | |
data.status | string | required | draft, active, paused, archived |
data.style_overrides | object | optional | |
data.total_submissions | integer | optional | |
data.total_views | integer | optional | |
data.type | string | required | contact, hiring, partner, survey, quiz, questionnaire, booking_intake, contract, custom |
data.updated_at | string | optional | |
data.version | integer | optional | |
data.website_ids | string[] | optional | |
success | boolean | required | true |
Errors 400401403404409422429500
curl https://api.getmeonline.io/v1/forms/{form_id} \
-H "Authorization: Bearer $GETME_API_KEY"