Search providers by free-text query

View as MarkdownOpen in Claude
Returns providers matching the supplied query, ranked by full-text relevance. Searches the provider name, address, postcode, and specialty. Results are restricted to the operator’s jurisdiction and the operator’s service scope. Each result carries operational signals (open hours, recent wait times) and a coarse data-quality tier so the network can be triaged without a second round-trip. Use the offset/limit parameters to step through large result sets; the response includes a `hasMore` flag and a running total.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

querystringRequired

Free-text query against provider name, address, postcode, and specialty.

serviceTypeCodestringOptional
Restrict results to providers offering this service type.
limitdoubleOptional1-50
Maximum number of results to return. Defaults to 10. Maximum 50.
offsetdoubleOptional>=0

Zero-based offset into the result set. Defaults to 0.

Response

A page of providers matching the text query.
datalist of objects
Provider rows matching the query, ranked by relevance.
paginationobject
Pagination metadata for stepping forward by offset.
metaobject