curl --request GET \
--url https://{subdomain}.conveyour.com/api/org \
--header 'x-conveyour-token: <api-key>'const options = {method: 'GET', headers: {'x-conveyour-token': '<api-key>'}};
fetch('https://{subdomain}.conveyour.com/api/org', 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/org', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{subdomain}.conveyour.com/api/org"
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/org",
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": {
"name": "Acme Inc",
"cg_style": "",
"cg_highlight": "#2b8aff",
"plan": {},
"limits": {
"campaigns": 100,
"automations": 100,
"groups": 100,
"sms_registration": 0,
"emails": 50000,
"users": 10,
"contacts": 25000,
"mal": 0,
"locations": 0,
"onboardees": 0,
"sms": 50000,
"video_upload": 0,
"portal_search": 0,
"workflows": 0,
"workflow_size": 0,
"teams": 0,
"custom_objects": 0,
"custom_records": 0,
"form_collections": 0,
"form_records": 0
},
"custom_domain": "app.acme.com",
"custom_domain_ssl": 1,
"trial_end": null,
"meta": {
"logo": "",
"icon": "",
"timezone": "America/New_York",
"portal_auth": {
"type": ""
}
},
"public_encryption_key": ""
}
}{
"status": "failed",
"message": "Lacking necessary permission add_contacts",
"data": {
"permission": "add_contacts"
}
}Get org settings
Returns the current organization’s settings, plan, limits, custom domain, and updatable meta.
Get the current org’s settings, plan, limits, and meta
curl --request GET \
--url https://{subdomain}.conveyour.com/api/org \
--header 'x-conveyour-token: <api-key>'const options = {method: 'GET', headers: {'x-conveyour-token': '<api-key>'}};
fetch('https://{subdomain}.conveyour.com/api/org', 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/org', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{subdomain}.conveyour.com/api/org"
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/org",
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": {
"name": "Acme Inc",
"cg_style": "",
"cg_highlight": "#2b8aff",
"plan": {},
"limits": {
"campaigns": 100,
"automations": 100,
"groups": 100,
"sms_registration": 0,
"emails": 50000,
"users": 10,
"contacts": 25000,
"mal": 0,
"locations": 0,
"onboardees": 0,
"sms": 50000,
"video_upload": 0,
"portal_search": 0,
"workflows": 0,
"workflow_size": 0,
"teams": 0,
"custom_objects": 0,
"custom_records": 0,
"form_collections": 0,
"form_records": 0
},
"custom_domain": "app.acme.com",
"custom_domain_ssl": 1,
"trial_end": null,
"meta": {
"logo": "",
"icon": "",
"timezone": "America/New_York",
"portal_auth": {
"type": ""
}
},
"public_encryption_key": ""
}
}{
"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
When true and the caller has an elevated (sudo) session, returns the org's full raw meta object instead of just the user-updatable meta keys.
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.