Skip to main content
GET
Get a shared lesson item

Authorizations

x-conveyour-token
string
header
required

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

Path Parameters

item_uuid
string
required

The item_uuid identifier.

id
string
required

The id identifier.

Query Parameters

start_time
integer

Unix timestamp filter — only records after this time.

end_time
integer

Unix timestamp filter — only records before this time.

con_id
string

Filter to a specific contact's records.

limit
integer

Max results to return. Default: 100 (JSON), 1000 (CSV).

offset
integer

Pagination offset. Default: 0.

format
string

Pass csv to download results as a CSV file.

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.

reviews_count
integer

How many reviews to include. Defaults to -1 (all).

trigger
string

Trigger ID to resolve the shared lesson item against.

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.