IntakeForms
List completed visit intake forms
Returns a paginated list of completed VisitIntakeForms, filtered by the supplied site, customer, basket or type. Use this to surface a guest's prior intake responses in customer-service flows and on the visit log.
get/shop/visit-intake-forms
Query parameters
site_idstring uuid required
The site to scope the search to.
customer_idstring uuid
Limit to intake forms filled out for this customer.
basket_idstring uuid
Limit to intake forms relating to this basket.
typestring
Limit to intake forms of the given type (e.g. mandatory).
pageinteger
The page to retrieve results from
per_pageinteger
The number of results to return per page
Response
A paginated list of VisitIntakeForms.
Example response
{
"links": {
"first": "http://example.com?page=1",
"next": "https://example.com?page=3",
"prev": "https://example.com?page=1",
"last": "https://example.com?page=4"
},
"meta": {
"from": 1,
"to": 2,
"total": 2,
"current_page": 1,
"last_page": 2,
"per_page": 15,
"path": "http://example.com/api"
},
"data": [
{
"id": "634d6e9f413841226003acc2",
"basket_id": "634d6e9f413841226003acc3",
"customer_id": "634d6e9f413841226003acc3",
"order_ref": "TRY123",
"guest_id": "634d6e9f413841226003acc4",
"type": "mandatory",
"completed_at": "2026-11-30T11:52:00+00:00",
"anonymised_at": "2027-11-30T11:52:00+00:00"
}
]
}Changes
No recorded changes to this endpoint across all 1 revision of this API.