Skip to main content
GET
Search lessons

Authorizations

x-conveyour-token
string
header
required

Your API key token. Contacts endpoints require a Server-only — Full API key — see Authentication.

Query Parameters

query
string
required

Search term. Uses full-text search. Supports special prefixes: has:<item_type> to filter by item type (e.g. has:video), event:<name> to filter by engagement event.

folder_id
string

Restrict search to a specific folder.

schema
string

Schema detail level. Default: full.

deleted
boolean

Pass 1 to include soft-deleted lessons.

teams[]
string[]

Team scope for the request, as one or more team ObjectIds. The brackets are required: PHP keeps only the last value for a repeated plain key, so teams=A&teams=B silently resolves to B alone. On requests with a JSON body you may send teams (no brackets) in the body instead.

Values that are not valid ObjectIds are silently ignored — a mistyped team ID behaves as if no team was sent. See the teams section of the API conventions guide.

item_types
array

Restrict results to lessons containing these item types. Repeat the key for multiple values.

Response

Success.

The common response envelope shared by all ConveYour endpoints.

status
enum<string>

ok on success, failed on error.

Available options:
ok,
failed
message
string

Human-readable description of the result.

data
object[]

The response payload — an object or an array depending on the endpoint.