Get a form

GET

/forms/{form_id}

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.

Authorization

headerAuthorizationBearer <token>

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

Prefix	What it is	Where it may be used
`agoo_sk_live_`	Secret key, live mode	Your servers only
`agoo_sk_test_`	Secret key, test mode	Your servers only
`agoo_pk_live_`	Publishable key, live mode	Browsers 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 mode	As 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.

Scope: forms:read

Path Parameters

form_id*string

The form's ID.

Match^form_[0-7][0-9a-hjkmnp-tv-z]{25}$

Example"form_01kk1602m0errvasw8gkt8f90b"

Response Body

The form.

application/json

response

A form built in the console, with the JSON Schema for its custom fields.

id*FormId

A form ID (TypeID with the form prefix).

Match^form_[0-7][0-9a-hjkmnp-tv-z]{25}$

Example"form_01kk1602m0errvasw8gkt8f90b"

name*string

Example"Contractor"

entity*FormEntity

The kind of object whose custom fields the form defines.

Value in"visit""person"

visit_type*|

For visit forms, the key of the visit type the form belongs to. null for person forms.

version*integer

Goes up each time the form is published.

Range1 <= value

schema*

A JSON Schema (draft 2020-12) for custom_fields. Property order is the order on screen; title is the label.

created_at*string

Formatdate-time

updated_at*string

Formatdate-time

curl -X GET 'https://api.agoohq.com/v1/forms/form_01kk1602m0errvasw8gkt8f90b'

{  "id": "form_01kk1602m0errvasw8gkt8f90b",  "name": "Contractor",  "entity": "visit",  "visit_type": "contractor",  "version": 3,  "schema": {    "$schema": "https://json-schema.org/draft/2020-12/schema",    "type": "object",    "properties": {      "contractor_company": {        "type": "string",        "title": "Contracting company",        "maxLength": 120      },      "work_order": {        "type": "string",        "title": "Work order number",        "pattern": "^WO-[0-9]{5}$"      },      "areas": {        "type": "array",        "title": "Areas needed",        "items": {          "enum": [            "server_room",            "generator_house",            "roof",            "banking_hall"          ]        },        "uniqueItems": true      },      "safety_induction_done": {        "type": "boolean",        "title": "Safety induction completed"      }    },    "required": [      "contractor_company",      "work_order",      "safety_induction_done"    ],    "additionalProperties": false  },  "created_at": "2026-03-06T09:00:00Z",  "updated_at": "2026-09-02T10:15:00Z"}

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Authorization

Path Parameters

Response Body