---
title: "List completed visit intake forms"
method: GET
path: "/shop/visit-intake-forms"
tags: ["IntakeForms"]
---

# List completed visit intake forms

`GET /shop/visit-intake-forms`

Returns a paginated list of completed `VisitIntakeForm`s, 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.

## Query parameters

- `site_id` string, uuid, required
- `customer_id` string, uuid
- `basket_id` string, uuid
- `type` string
- `page` integer
- `per_page` integer

## Response `200`

A paginated list of `VisitIntakeForm`s.

- object — Paginated envelope mixin. `allOf` this into any list response that wraps its `data` array with `meta` + `links`; the concrete schema keeps its own title so the SDK surface is unchanged, while the `meta` / `links` shape is sourced from a single definition.
  - `links` PaginationLinks, required — Hypermedia navigation links for paging through a list response. Each property is a fully-qualified URL that preserves the original query string (filters, sort, page size) and only swaps the `page` parameter. `next` and `prev` are `null` at the ends of the result set; `first` and `last` are always present.
    - `first` string, required — The url of the first page for the paginated results set
    - `next` string, nullable, required — The url of the next page for the paginated results set
    - `prev` string, nullable, required — The url of the previous page for the paginated results set
    - `last` string, required — The url of the last page for the paginated results set
  - `meta` PaginationMeta, required — Counts and positional information for the current page of a list response. Use `current_page` and `last_page` to drive pagination UI, `total` for result counts, and `per_page` to confirm the page size the server actually applied (which may differ from the requested value when capped).
    - `from` integer, required — The item number from which this results set starts from
    - `to` integer, required — The item number from which this results set ends at
    - `total` integer, required — The total number of results
    - `current_page` integer, required — The current page number
    - `last_page` integer, required — The page number of the last result set
    - `per_page` integer, required — The number of results per page
    - `path` string, required — The path of this api request
  - `data` VisitIntakeForm[], required
    - `id` string, required — The ID of the visit intake form.
    - `basket_id` string, required — The ID of the basket the intake form relates to.
    - `customer_id` string, nullable, required — The ID of the customer the intake form was filled out for, if the guest is linked to a customer account.
    - `order_ref` string, required — The human-readable reference of the parent order.
    - `guest_id` string, required — The ID of the guest the intake form was filled out for.
    - `type` string, nullable, required — The type identifier for the intake form (e.g. `mandatory`, `optional`, `treatment-specific`).
    - `completed_at` string, date-time, required — When the intake form was filled out.
    - `anonymised_at` string, date-time, nullable — When the captured data was anonymised (typically after the retention window has elapsed).

## Other responses

- `401` — The user is unauthenticated

---

[API](https://skmtc.dev/try/apis/trybe-api.md) · [All operations](https://skmtc.dev/try/apis/trybe-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/try/trybe-api/revisions/f37f92702da5/schema)