Get a visit type
/visit-types/{visit_type}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.
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.
In: header
Scope: forms:read
Path Parameters
The visit type's key.
^[a-z][a-z0-9_]{0,39}$"meeting""contractor""parent_pickup"Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/visit-types/meeting"{ "key": "contractor", "name": "Contractor", "built_in": true, "enabled": true, "pre_registration": true, "form_id": "form_01kk1602m0errvasw8gkt8f90b", "public_form": { "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 } }, "required": [ "contractor_company", "work_order" ], "additionalProperties": false } }, "created_at": "2026-03-02T08:14:00Z", "updated_at": "2026-09-02T10:15:00Z"}List visit types GET
Returns your organisation's visit types: the six built-in types, renamed or not, and the types your admins have added, such as "Parent pickup" or "Vendor". Built-in types come first, then the others by name. Use a type's `key` as `type` when you create a visit, and its `form_id` to read the questions that type asks. Types that are turned off (`enabled: false`) are included so you can still read older visits; leave them out with `enabled=true`. Types open for pre-registration (`pre_registration: true`) carry a `public_form`: the questions a visitor answers when they pre-register, without the fields your staff fill in. **Scope:** `forms:read` · **Plan:** Pro and Enterprise in live mode; every plan in test mode. **Publishable keys:** allowed. They see only the types that are turned on and open for pre-registration, so a pre-registration form can offer exactly those.
List forms GET
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.