Docs
API referenceForms

List forms

Preview· P9
GET/forms

Returns your organisation's active forms, each with the JSON Schema for its custom fields. There is one visit form per visit type, including the types your organisation adds, and one person form. Read them to know which custom_fields keys and values a visit or person accepts. GET /visit-types lists the types.

Forms include the fields your staff fill in, so publishable keys can't read them. A pre-registration form gets the visitor's questions from the type's public_form in GET /visit-types instead.

Scope: forms:read · Plan: Pro and Enterprise in live mode; every plan in test mode.

Authorization

AuthorizationBearer <token>

Send Authorization: Bearer <token> on every request. The token is one of:

PrefixWhat it isWhere it may be used
agoo_sk_live_Secret key, live modeYour servers only
agoo_sk_test_Secret key, test modeYour servers only
agoo_pk_live_Publishable key, live modeBrowsers and apps: create pre-registrations and bookings, read public booking types (with their intake questions) and their free slots, read the visit types open for pre-registration with their public forms. Never lists people.
agoo_pk_test_Publishable key, test modeAs above, in test mode

Admins create keys in Console → Developers → API keys and choose each key's scopes. A key is shown once. Never put a secret key in a URL, a browser or a mobile app.

In: header

Scope: forms:read

Query Parameters

limit?integer

How many items to return, from 1 to 100.

Range1 <= value <= 100
Default25
cursor?string

The next_cursor from the previous page. Leave it out for the first page.

Lengthlength <= 512
entity?string

Only forms for this kind of object.

Value in

  • "visit"
  • "person"
visit_type?string

Only the visit form for this visit type, by key.

Match^[a-z][a-z0-9_]{0,39}$
Example"meeting"
Example"contractor"
Example"parent_pickup"

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/forms?limit=25&entity=visit&visit_type=contractor"
{  "data": [    {      "id": "form_01kk16jcj0fapr5z3qmqxgvpvv",      "name": "Meeting guest",      "entity": "visit",      "visit_type": "meeting",      "version": 2,      "schema": {        "$schema": "https://json-schema.org/draft/2020-12/schema",        "type": "object",        "properties": {          "vehicle_plate": {            "type": "string",            "title": "Vehicle number plate",            "maxLength": 12          },          "bringing_laptop": {            "type": "boolean",            "title": "Bringing a laptop?"          }        },        "additionalProperties": false      },      "created_at": "2026-03-06T09:10:00Z",      "updated_at": "2026-07-21T15:40:00Z"    }  ],  "next_cursor": null,  "has_more": false}

Get a visit type GET

Returns one visit type by its key, whether it's turned on or off. A key your organisation doesn't have returns `not_found`. A type open for pre-registration includes its `public_form`. **Scope:** `forms:read` · **Plan:** Pro and Enterprise in live mode; every plan in test mode. **Publishable keys:** allowed for types that are turned on and open for pre-registration. Any other key returns `not_found`.

Get a form GET

Returns one form with its JSON Schema. `version` goes up each time an admin publishes a change in the form builder. **Scope:** `forms:read` · **Plan:** Pro and Enterprise in live mode; every plan in test mode.