curl --request GET \
--url https://{subdomain}.conveyour.com/api/custom/records \
--header 'x-conveyour-token: <api-key>'const options = {method: 'GET', headers: {'x-conveyour-token': '<api-key>'}};
fetch('https://{subdomain}.conveyour.com/api/custom/records', 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/records', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{subdomain}.conveyour.com/api/custom/records"
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/records",
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": "success",
"data": [
{
"id": "64a1b2c3d4e5f6a7b8c9d0e1",
"obj_id": "64a1b2c3d4e5f6a7b8c9d0e2",
"external_id": "vin-123",
"make": "Ford",
"model": "F-150",
"year": 2022
}
]
}{
"status": "failed",
"message": "Lacking necessary permission add_contacts",
"data": {
"permission": "add_contacts"
}
}List records
Returns a paginated list of records. Filter by object type using obj_id or obj_name.
List records (supports pagination, search, sort, CSV export)
Permission: Requires manage_custom_objects, manage_custom_records or custom_objects. Denials read View Custom Records.
Response shape: data is an object with count, page, pages, per_page, has_more, has_less and results. per_page is honoured.
curl --request GET \
--url https://{subdomain}.conveyour.com/api/custom/records \
--header 'x-conveyour-token: <api-key>'const options = {method: 'GET', headers: {'x-conveyour-token': '<api-key>'}};
fetch('https://{subdomain}.conveyour.com/api/custom/records', 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/records', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{subdomain}.conveyour.com/api/custom/records"
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/records",
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": "success",
"data": [
{
"id": "64a1b2c3d4e5f6a7b8c9d0e1",
"obj_id": "64a1b2c3d4e5f6a7b8c9d0e2",
"external_id": "vin-123",
"make": "Ford",
"model": "F-150",
"year": 2022
}
]
}{
"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
Filter records by Custom Object type ID. Recommended to always pass this to scope results to the right object type.
Alternative to obj_id — filter by object type name/slug.
Text search across record fields.
Sort spec: { "field_name": 1 } for ascending, { "field_name": -1 } for descending. Pass plain field_name for custom data fields — the API adds the d. prefix automatically. Passing d.field_name will double-prefix the path. System fields (created_at, updated_at, external_id, etc.) are passed as-is.
Page number (1-based). When omitted or 0, returns a flat array with no pagination. When set to 1 or higher, returns paginated results. Default: 0 (no pagination).
Records per page when pagination is enabled (page ≥ 1). Default: 100.
Pass csv to download results as a CSV file instead of JSON.
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.