Skip to main content
GET
Search the storefront catalogue

Authorizations

Authorization
string
header
required

A member credential in the Authorization: Bearer header: a member session JWT, a portal JWT whose login is linked to a membership in that company, or an opaque member token. The credential alone identifies the member and company.

Query Parameters

q
string
required

Search text, 2 to 200 characters.

Required string length: 2 - 200
types
string

Comma-separated types to search: products, enrollment-packs, pages, media, playlists or posts. All six by default.

Maximum string length: 200
Example:

"products,media"

page[cursor]
string

Opaque cursor from meta.pagination.next_cursor. Expires after one hour and only continues the same query and types. A catalogue reindex between pages invalidates it with a 400; repeat the search without a cursor.

page[limit]
integer
default:25

Maximum number of hits returned.

Required range: 1 <= x <= 50

Response

A page of hits.

One page of search results.

status
integer
required

HTTP response status.

data
object[]
required

Hits, best match first.

meta
object
required

Envelope metadata with per-type facets and the search cursor.