curl --request GET \
--url https://{subdomain}.conveyour.com/api/custom/objects/schema \
--header 'x-conveyour-token: <api-key>'const options = {method: 'GET', headers: {'x-conveyour-token': '<api-key>'}};
fetch('https://{subdomain}.conveyour.com/api/custom/objects/schema', 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/custom/objects/schema', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{subdomain}.conveyour.com/api/custom/objects/schema"
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/custom/objects/schema",
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": "Custom Object schema",
"data": {
"schema": {
"field_types": [
{
"type": "Text",
"label": "Text"
},
{
"type": "TextArea",
"label": "Text Area"
},
{
"type": "Number",
"label": "Number"
},
{
"type": "Date",
"label": "Date"
},
{
"type": "DateTime",
"label": "Date & Time"
},
{
"type": "Select",
"label": "Select"
},
{
"type": "Checkbox",
"label": "Yes/No"
},
{
"type": "List",
"label": "List"
},
{
"type": "ListSelect",
"label": "List Select"
},
{
"type": "Liquid",
"label": "Liquid"
},
{
"type": "Image",
"label": "Image"
},
{
"type": "Relation",
"label": "Relation"
}
]
}
}
}{
"status": "failed",
"message": "Lacking necessary permission add_contacts",
"data": {
"permission": "add_contacts"
}
}Get custom object schema
Returns the meta-schema — the field types and options available when defining a Custom Object. Use this before creating a Custom Object to understand which field types are supported.
Get the meta-schema for field types
Permission: Requires manage_custom_objects, manage_custom_records or custom_objects. Denials read View Custom Objects.
curl --request GET \
--url https://{subdomain}.conveyour.com/api/custom/objects/schema \
--header 'x-conveyour-token: <api-key>'const options = {method: 'GET', headers: {'x-conveyour-token': '<api-key>'}};
fetch('https://{subdomain}.conveyour.com/api/custom/objects/schema', 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/custom/objects/schema', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{subdomain}.conveyour.com/api/custom/objects/schema"
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/custom/objects/schema",
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": "Custom Object schema",
"data": {
"schema": {
"field_types": [
{
"type": "Text",
"label": "Text"
},
{
"type": "TextArea",
"label": "Text Area"
},
{
"type": "Number",
"label": "Number"
},
{
"type": "Date",
"label": "Date"
},
{
"type": "DateTime",
"label": "Date & Time"
},
{
"type": "Select",
"label": "Select"
},
{
"type": "Checkbox",
"label": "Yes/No"
},
{
"type": "List",
"label": "List"
},
{
"type": "ListSelect",
"label": "List Select"
},
{
"type": "Liquid",
"label": "Liquid"
},
{
"type": "Image",
"label": "Image"
},
{
"type": "Relation",
"label": "Relation"
}
]
}
}
}{
"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
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.