Skip to main content
GET
List 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

folder_id
string

Filter lessons by folder. Pass a folder ID to scope to that folder.

schema
string

Schema detail level. Use small for a lightweight response with minimal fields. Default: full.

count
integer

Pass count=1 to return a count of lessons instead of the full list.

deleted
boolean

Pass 1 to include soft-deleted lessons. Default: 0.

query
string

Text search filter (also supported on the list endpoint, not just /search).

item_types
string[]

Filter by lesson item type(s). Pass as repeated query params: item_types[]=video.

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.

download
boolean

Return the lesson as a downloadable file rather than JSON.

format
string

Set to csv to receive a CSV export instead of JSON.

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.