curl --request GET \
--url https://{subdomain}.conveyour.com/api/tasks/{id} \
--header 'x-conveyour-token: <api-key>'const options = {method: 'GET', headers: {'x-conveyour-token': '<api-key>'}};
fetch('https://{subdomain}.conveyour.com/api/tasks/{id}', 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/tasks/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{subdomain}.conveyour.com/api/tasks/{id}"
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/tasks/{id}",
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": "<string>",
"data": {
"name": "<string>",
"id": "<string>",
"org_id": 123,
"status": "not_started",
"body": "<string>",
"assigned_to": [
123
],
"related_records": [
"<string>"
],
"resources": [
{
"type": "url",
"value": "<string>"
}
],
"slug": "<string>",
"meta": {},
"created_at": "<string>",
"updated_at": "<string>",
"related_record_summary": [
{
"id": "<string>",
"type": "trigger",
"title": "<string>",
"related_record_key": "<string>",
"trigger_type": "<string>",
"campaign_id": "<string>"
}
]
}
}Get a task
Returns one task, with related-record detail attached.
curl --request GET \
--url https://{subdomain}.conveyour.com/api/tasks/{id} \
--header 'x-conveyour-token: <api-key>'const options = {method: 'GET', headers: {'x-conveyour-token': '<api-key>'}};
fetch('https://{subdomain}.conveyour.com/api/tasks/{id}', 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/tasks/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{subdomain}.conveyour.com/api/tasks/{id}"
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/tasks/{id}",
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": "<string>",
"data": {
"name": "<string>",
"id": "<string>",
"org_id": 123,
"status": "not_started",
"body": "<string>",
"assigned_to": [
123
],
"related_records": [
"<string>"
],
"resources": [
{
"type": "url",
"value": "<string>"
}
],
"slug": "<string>",
"meta": {},
"created_at": "<string>",
"updated_at": "<string>",
"related_record_summary": [
{
"id": "<string>",
"type": "trigger",
"title": "<string>",
"related_record_key": "<string>",
"trigger_type": "<string>",
"campaign_id": "<string>"
}
]
}
}Authorizations
Your API key token. Contacts endpoints require a Server-only — Full API key — see Authentication.
Path Parameters
The task ID.
Query Parameters
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.
Response
Success.
The common response envelope shared by all ConveYour endpoints.
ok on success, failed on error.
ok, failed Human-readable description of the result.
Single-record reads and updates add related-record detail via formatModelFull(). Only records that still exist are included — a related record that has been deleted is silently dropped from both arrays.
Show child attributes
Show child attributes