Skip to content
campaiDeveloper
campai.com

Crm · Passes · Templates

GET/{organizationId}/{mandateId}/crm/passes/templates/{templateId}/print-designReads only

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.read
  • contact:member.read
  • contact:address.read
  • contact:customer.read
  • contact:sponsor.read
  • contact:contributor.read
  • contact:employee.read
  • contact:supplier.read

Request

Path parameters

  • organizationIdidrequired
  • mandateIdidrequired
  • templateIdidrequired
Request
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'

Response

200 Successful response

Content-Type: application/json

  • designobject
    8 properties
    • versionnumber
    • channelstring
    • containerobject
      6 properties
      • typestring
      • idstring

        pattern ^[a-zA-Z0-9_-]+$

      • repeatobjectnullable
        1 property
        • sourceobject
          1 property
          • variablestring

            at least 1 characters

      • pageSizeobject
        3 properties
        • widthnumber
        • heightnumber
        • landscapeboolean
      • fontFamilystring
      • itemsobject[]
        11 properties
        • idstring

          pattern ^[a-zA-Z0-9_-]+$

        • namestring

          at most 32 characters

        • hiddenboolean
        • lockedboolean
        • conditionobjectnullable
          2 properties
          • operatorstring
            and or
          • conditions(object (recursive) | object)[]

            at least 1 items

            4 properties
            • leftobject | object of any
              Variant 1: 1 property
              • variablestring

                at least 1 characters

              Variant 2: 4 properties
              • sourceobject
                1 property
                • variablestring

                  at least 1 characters

              • lookupobjectnullable
                1 property
                • variablestring

                  at least 1 characters

              • arrayboolean
              • selectobject (recursive)
              Variant 3: 2 properties
              • funcstring
                33 values
                concat ifEmpty lowercase uppercase substring trim abs ceil floor min max mod sum sub mul div avg med parseNumber formatNumber dateOnly dateTime dateOnlyPart dateTimePart age dateOnlyDifference dateTimeDifference setDateOnly setDateTime addDateOnly addDateTime formatDateOnly formatDateTime
              • paramsobject (recursive)[]
              Variant 4: 1 property
              • literalnumber[] | number
              Variant 5: 3 properties
              • ifobject (recursive)
              • thenobject (recursive)
              • elseobject (recursive)
            • cmpFuncstring
              15 values
              eq isSet lt lte gt gte includes contains startsWith endsWith before beforeAt after afterAt isToday
            • rightobject | object of any
              Variant 1: 1 property
              • variablestring

                at least 1 characters

              Variant 2: 4 properties
              • sourceobject
                1 property
                • variablestring

                  at least 1 characters

              • lookupobjectnullable
                1 property
                • variablestring

                  at least 1 characters

              • arrayboolean
              • selectobject (recursive)
              Variant 3: 2 properties
              • funcstring
                33 values
                concat ifEmpty lowercase uppercase substring trim abs ceil floor min max mod sum sub mul div avg med parseNumber formatNumber dateOnly dateTime dateOnlyPart dateTimePart age dateOnlyDifference dateTimeDifference setDateOnly setDateTime addDateOnly addDateTime formatDateOnly formatDateTime
              • paramsobject (recursive)[]
              Variant 4: 1 property
              • literalnumber[] | number
              Variant 5: 3 properties
              • ifobject (recursive)
              • thenobject (recursive)
              • elseobject (recursive)
            • negateboolean
        • typestring
        • repeatobjectnullable
          1 property
          • sourceobject
            1 property
            • variablestring

              at least 1 characters

        • marginany[]

          exactly 4 items

        • backgroundobject
          3 properties
          • backgroundColorobject
            2 properties
            • colorstring

              pattern ^#[0-9A-F]{6}$

            • hideboolean
          • backgroundGradientobject
            3 properties
            • hideboolean
            • stopsobject[]
              2 properties
              • colorstring

                pattern ^#[0-9A-F]{6,8}$

              • positionnumber

                at least 0

            • angleinteger
          • backgroundImageobject
            4 properties
            • hideboolean
            • imageobjectnullable
            • sizestring
              cover contain fill tile
            • positionstring
              top left top center top right middle left middle center middle right bottom left bottom center bottom right
        • foldingMarksobject[]
          3 properties
          • topnumber
          • leftnumber
          • widthnumber
        • itemsobject[]
    • unitstring
      px pt mm in
    • languagesstring[]

      at least 1 items · each at least 2 characters

    • onlineLetterboolean
    • resourcesobject[]
      5 properties
      • resourcestring

        at least 1 characters

      • fileNamestring

        at most 128 characters

      • contentTypestring

        at most 75 characters

      • fileSizeBytesinteger

        at least 0

      • idstring

        exactly 6 characters

    • attachmentobjectnullable
      3 properties
      • resourceIdstring

        exactly 6 characters

      • modestring
        overlay prepend append
      • pagesinteger
  • sampleobject
    9 properties
    • languagestring
    • passConstraintsobjectnullable
      2 properties
      • barcodeobjectnullable
        2 properties
        • formatstring
          qrcode code128 pdf417 aztec
        • contentobject
          1 property
          • variablestring

            at least 1 characters

      • expiresAtobjectnullable
        1 property
        • variablestring

          at least 1 characters

    • fixedPaperFormatobjectnullable
      4 properties
      • unitstring
        px pt mm in
      • widthnumber
      • heightnumber
      • landscapeboolean
    • variablesobject of object
    • propertiesobject of object
    • collectionsobject of object
    • richContentobject of string
      markdown html
    • stackobject of one of 5 types[]
    • displayStackobject of one of 5 types[]
  • contactTypestring
    member address customer sponsor contributor employee supplier
  • useRecognizableBarcodeboolean
  • designRevisioninteger

    at least 0

  • printFormatConfiguredboolean
  • publishedAtstring · date-timenullable
Response200
{
  "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.