Crm · Passes · Templates
Get pass print design
Returns the native print design and permitted synthetic composition sample without changing the template.
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Permission checks in detail
Required permissions
contactPassTemplate.edit
Also checked, depending on the request and the records it touches
mandate.readcontact:member.readcontact:address.readcontact:customer.readcontact:sponsor.readcontact:contributor.readcontact:employee.readcontact:supplier.read
Request
Path parameters
-
organizationIdidrequired -
mandateIdidrequired -
templateIdidrequired
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request GET 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/crm/passes/templates/YOUR_TEMPLATE_ID/print-design' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/crm/passes/templates/YOUR_TEMPLATE_ID/print-design", {
method: "GET",
headers: {
"X-API-Key": "YOUR_API_KEY"
},
redirect: 'error',
signal: AbortSignal.timeout(30_000),
});
if (!response.ok) throw new Error(`campai HTTP ${response.status}`);
const text = await response.text();
const result = text ? JSON.parse(text) : null;
console.log(JSON.stringify(result, null, 2));<?php
$context = stream_context_create(['http' => [
'method' => 'GET',
'header' => [
'X-API-Key: YOUR_API_KEY',
],
'timeout' => 30,
'follow_location' => 0,
'ignore_errors' => true,
]]);
$text = @file_get_contents('https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/YOUR_MANDATE_ID/crm/passes/templates/YOUR_TEMPLATE_ID/print-design', false, $context);
preg_match('/^HTTP\/\S+ (\d{3})/', $http_response_header[0] ?? '', $match);
$status = (int) ($match[1] ?? 0);
if ($text === false || $status < 200 || $status >= 300) {
throw new RuntimeException("campai HTTP $status (0 means no response)");
}
$result = $text === '' ? null : json_decode($text, true, 512, JSON_THROW_ON_ERROR);
echo json_encode($result, JSON_PRETTY_PRINT | JSON_THROW_ON_ERROR), PHP_EOL;
Response
200 Successful response
Content-Type: application/json
-
designobject8 properties
-
versionnumber -
channelstring -
containerobject6 properties
-
typestring -
idstringpattern
^[a-zA-Z0-9_-]+$ -
repeatobjectnullable1 property
-
sourceobject1 property
-
variablestringat least 1 characters
-
-
-
pageSizeobject3 properties
-
widthnumber -
heightnumber -
landscapeboolean
-
-
fontFamilystring -
itemsobject[]11 properties
-
idstringpattern
^[a-zA-Z0-9_-]+$ -
namestringat most 32 characters
-
hiddenboolean -
lockedboolean -
conditionobjectnullable2 properties
-
operatorstringandor -
conditions(object (recursive) | object)[]at least 1 items
4 properties
-
leftobject | object of anyVariant 1: 1 property
-
variablestringat least 1 characters
Variant 2: 4 properties
-
sourceobject1 property
-
variablestringat least 1 characters
-
-
lookupobjectnullable1 property
-
variablestringat least 1 characters
-
-
arrayboolean -
selectobject (recursive)
Variant 3: 2 properties
-
funcstring33 values
concatifEmptylowercaseuppercasesubstringtrimabsceilfloorminmaxmodsumsubmuldivavgmedparseNumberformatNumberdateOnlydateTimedateOnlyPartdateTimePartagedateOnlyDifferencedateTimeDifferencesetDateOnlysetDateTimeaddDateOnlyaddDateTimeformatDateOnlyformatDateTime -
paramsobject (recursive)[]
Variant 4: 1 property
-
literalnumber[] | number
Variant 5: 3 properties
-
ifobject (recursive) -
thenobject (recursive) -
elseobject (recursive)
-
-
cmpFuncstring15 values
eqisSetltltegtgteincludescontainsstartsWithendsWithbeforebeforeAtafterafterAtisToday -
rightobject | object of anyVariant 1: 1 property
-
variablestringat least 1 characters
Variant 2: 4 properties
-
sourceobject1 property
-
variablestringat least 1 characters
-
-
lookupobjectnullable1 property
-
variablestringat least 1 characters
-
-
arrayboolean -
selectobject (recursive)
Variant 3: 2 properties
-
funcstring33 values
concatifEmptylowercaseuppercasesubstringtrimabsceilfloorminmaxmodsumsubmuldivavgmedparseNumberformatNumberdateOnlydateTimedateOnlyPartdateTimePartagedateOnlyDifferencedateTimeDifferencesetDateOnlysetDateTimeaddDateOnlyaddDateTimeformatDateOnlyformatDateTime -
paramsobject (recursive)[]
Variant 4: 1 property
-
literalnumber[] | number
Variant 5: 3 properties
-
ifobject (recursive) -
thenobject (recursive) -
elseobject (recursive)
-
-
negateboolean
-
-
-
typestring -
repeatobjectnullable1 property
-
sourceobject1 property
-
variablestringat least 1 characters
-
-
-
marginany[]exactly 4 items
-
backgroundobject3 properties
-
backgroundColorobject2 properties
-
colorstringpattern
^#[0-9A-F]{6}$ -
hideboolean
-
-
backgroundGradientobject3 properties
-
hideboolean -
stopsobject[]2 properties
-
colorstringpattern
^#[0-9A-F]{6,8}$ -
positionnumberat least 0
-
-
angleinteger
-
-
backgroundImageobject4 properties
-
hideboolean -
imageobjectnullable -
sizestringcovercontainfilltile -
positionstringtop lefttop centertop rightmiddle leftmiddle centermiddle rightbottom leftbottom centerbottom right
-
-
-
foldingMarksobject[]3 properties
-
topnumber -
leftnumber -
widthnumber
-
-
itemsobject[]
-
-
-
unitstringpxptmmin -
languagesstring[]at least 1 items · each at least 2 characters
-
onlineLetterboolean -
resourcesobject[]5 properties
-
resourcestringat least 1 characters
-
fileNamestringat most 128 characters
-
contentTypestringat most 75 characters
-
fileSizeBytesintegerat least 0
-
idstringexactly 6 characters
-
-
attachmentobjectnullable3 properties
-
resourceIdstringexactly 6 characters
-
modestringoverlayprependappend -
pagesinteger
-
-
-
sampleobject9 properties
-
languagestring -
passConstraintsobjectnullable2 properties
-
barcodeobjectnullable2 properties
-
formatstringqrcodecode128pdf417aztec -
contentobject1 property
-
variablestringat least 1 characters
-
-
-
expiresAtobjectnullable1 property
-
variablestringat least 1 characters
-
-
-
fixedPaperFormatobjectnullable4 properties
-
unitstringpxptmmin -
widthnumber -
heightnumber -
landscapeboolean
-
-
variablesobject of object -
propertiesobject of object -
collectionsobject of object -
richContentobject of stringmarkdownhtml -
stackobject of one of 5 types[] -
displayStackobject of one of 5 types[]
-
-
contactTypestringmemberaddresscustomersponsorcontributoremployeesupplier -
useRecognizableBarcodeboolean -
designRevisionintegerat least 0
-
printFormatConfiguredboolean -
publishedAtstring · date-timenullable
{
"design": {
"version": 1,
"channel": "paper",
"container": {
"type": "container",
"id": "string",
"repeat": {
"source": {
"variable": "string"
}
},
"pageSize": {
"width": 1,
"height": 1,
"landscape": true
},
"fontFamily": "string",
"items": [
{
"id": "string",
"name": "string",
"hidden": true,
"locked": true,
"condition": {
"operator": "and",
"conditions": [
null
]
},
"type": "page",
"repeat": {
"source": {
"variable": "string"
}
},
"margin": [
null
],
"background": {
"backgroundColor": {
"color": "string",
"hide": true
},
"backgroundGradient": {
"hide": true,
"stops": [
{
"color": "string",
"position": 0
}
],
"angle": 1
},
"backgroundImage": {
"hide": true,
"image": {
"type": "resource",
"resourceId": "string"
},
"size": "cover",
"position": "top left"
}
},
"foldingMarks": [
{
"top": 1,
"left": 1,
"width": 1
}
],
"items": [
{
"id": "string",
"name": "string",
"hidden": true,
"locked": true,
"condition": {
"operator": "and",
"conditions": [
null
]
},
"margin": [
null
],
"padding": [
null
],
"radius": 0,
"background": {
"backgroundColor": {
"color": "string",
"hide": true
},
"backgroundGradient": {
"hide": true,
"stops": [
{
"color": "string",
"position": 0
}
],
"angle": 1
},
"backgroundImage": {
"hide": true,
"image": {
"type": "resource",
"resourceId": null
},
"size": "cover",
"position": "top left"
}
},
"border": {
"color": "string",
"width": 0,
"style": "solid",
"hide": true
},
"orientation": "horizontal",
"placement": "top left",
"gapX": 0,
"gapY": 0,
"type": "section",
"repeat": {
"source": {
"variable": "string"
}
},
"height": {
"value": 0,
"unit": "#"
},
"items": [
{
"id": "string",
"name": "string",
"hidden": true,
"locked": true,
"condition": null,
"margin": [
null
],
"radius": 0,
"background": {
"backgroundColor": {
"color": null,
"hide": null
},
"backgroundGradient": {
"hide": null,
"stops": null,
"angle": null
},
"backgroundImage": {
"hide": null,
"image": null,
"size": "cover",
"position": "top left"
}
},
"border": {
"color": "string",
"width": null,
"style": "solid",
"hide": true
},
"type": "table",
"width": {
"value": 0,
"unit": "#"
},
"hasHeaderRow": true,
"items": [
{
"id": null,
"name": null,
"hidden": null,
"locked": null,
"condition": null,
"type": "tableRow",
"height": null,
"repeat": null,
"placement": "top left",
"backgroundColor": null,
"items": null
}
]
}
]
}
]
}
]
},
"unit": "px",
"languages": [
"string"
],
"onlineLetter": true,
"resources": [
{
"resource": "string",
"id": "string"
}
],
"attachment": {
"resourceId": "string",
"mode": "overlay",
"pages": 1
}
},
"sample": {
"language": "string",
"passConstraints": {
"barcode": {
"format": "qrcode",
"content": {
"variable": "string"
}
},
"expiresAt": {
"variable": "string"
}
},
"fixedPaperFormat": {
"unit": "px",
"width": 1,
"height": 1,
"landscape": true
},
"variables": {
"key": {
"type": "string"
}
},
"properties": {
"key": {
"path": "string",
"property": {
"name": "string",
"format": "string"
}
}
},
"collections": {
"key": {
"path": "string",
"group": {
"groupName": "string",
"properties": {
"key": {
"name": "string",
"format": "string"
}
},
"array": true,
"name": "string"
}
}
},
"richContent": {
"key": "markdown"
},
"stack": [
{
"key": "string"
}
],
"displayStack": [
{
"key": "string"
}
]
},
"contactType": "member",
"useRecognizableBarcode": true,
"designRevision": 0,
"printFormatConfigured": true,
"publishedAt": "2026-06-15T22:30:00Z"
}
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.