Sign in
IntakeForms

Get visit intake forms for an order

Returns the IDs of the VisitIntakeForms associated with an order. Although the operation is read-only the request uses POST so a complex order/basket selector can be supplied without fitting it into a URL query string.

post/shop/visit-intake-forms-for-orders

Query parameters

basket_idstring required

The basket to look up intake forms for.

site_idstring required

The site the basket belongs to.

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