curl --request GET \
--url https://{subdomain}.conveyour.com/api/lessons/{id}/shared/{item_uuid} \
--header 'x-conveyour-token: <api-key>'const options = {method: 'GET', headers: {'x-conveyour-token': '<api-key>'}};
fetch('https://{subdomain}.conveyour.com/api/lessons/{id}/shared/{item_uuid}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const options = {method: 'GET', headers: {'x-conveyour-token': '<api-key>'}};
fetch('https://{subdomain}.conveyour.com/api/lessons/{id}/shared/{item_uuid}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{subdomain}.conveyour.com/api/lessons/{id}/shared/{item_uuid}"
headers = {"x-conveyour-token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{subdomain}.conveyour.com/api/lessons/{id}/shared/{item_uuid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-conveyour-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"status": "ok",
"message": "results found",
"data": {
"total": 42,
"offset": 0,
"records": [
{
"$cid": "64a1b2c3d4e5f6a7b8c9d0e1",
"$name": "Jane Doe",
"$timestamp": 1718438400,
"meta": {}
}
]
}
}{
"status": "failed",
"message": "Lacking necessary permission add_contacts",
"data": {
"permission": "add_contacts"
}
}Get a shared lesson item
Returns shared engagement records for a specific lesson item (e.g. poll responses or video uploads visible to other learners).
Get shared engagement records for a lesson item
A missing record does not return 404. This handler reports the failure without a status code, and the error envelope defaults to HTTP 200 — you get 200 with status: "failed". Branch on status, not on the HTTP code.
curl --request GET \
--url https://{subdomain}.conveyour.com/api/lessons/{id}/shared/{item_uuid} \
--header 'x-conveyour-token: <api-key>'const options = {method: 'GET', headers: {'x-conveyour-token': '<api-key>'}};
fetch('https://{subdomain}.conveyour.com/api/lessons/{id}/shared/{item_uuid}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));const options = {method: 'GET', headers: {'x-conveyour-token': '<api-key>'}};
fetch('https://{subdomain}.conveyour.com/api/lessons/{id}/shared/{item_uuid}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{subdomain}.conveyour.com/api/lessons/{id}/shared/{item_uuid}"
headers = {"x-conveyour-token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{subdomain}.conveyour.com/api/lessons/{id}/shared/{item_uuid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-conveyour-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"status": "ok",
"message": "results found",
"data": {
"total": 42,
"offset": 0,
"records": [
{
"$cid": "64a1b2c3d4e5f6a7b8c9d0e1",
"$name": "Jane Doe",
"$timestamp": 1718438400,
"meta": {}
}
]
}
}{
"status": "failed",
"message": "Lacking necessary permission add_contacts",
"data": {
"permission": "add_contacts"
}
}Authorizations
Your API key token. Contacts endpoints require a Server-only — Full API key — see Authentication.
Query Parameters
Unix timestamp filter — only records after this time.
Unix timestamp filter — only records before this time.
Filter to a specific contact's records.
Max results to return. Default: 100 (JSON), 1000 (CSV).
Pagination offset. Default: 0.
Pass csv to download results as a CSV file.
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.
How many reviews to include. Defaults to -1 (all).
Trigger ID to resolve the shared lesson item against.
Response
Success.
The common response envelope shared by all ConveYour endpoints.