getQuery()
Returns the parsed query string parameters from the request.
Syntax
const query = getQuery(event) Parameters
| Name | Type | Required | Description |
|---|---|---|---|
event | H3Event | Yes | The request event. |
Returns
Record<string, string | string[]> — Parsed query parameters object.
Examples
// server/api/search.get.ts -> /api/search?q=nuxt&page=2
export default defineEventHandler((event) => {
const { q, page = '1' } = getQuery(event)
return search(String(q), Number(page))
})
export default defineEventHandler((event) => {
const query = getQuery<{ ids?: string }>(event)
const ids = query.ids?.split(',') ?? []
return ids
})
Notes
Values are always strings (or string arrays for repeated keys), so
coerce numbers/booleans yourself. For typed safety, validate the
object with a schema. Use `getRouterParam` for dynamic path segments
rather than query params.