Skip to content
campai
Book a consultationTry for free
GET/{organizationId}/{mandateId}/crm/passes/templates/{templateId}

Gets a specific pass template with all of its details

Required permissions:

  • mandate.read

  • contactPassTemplate.read

Path Parameters

organizationIdstringrequired
mandateIdstringrequired
templateIdstringrequired

Authentication: X-API-Key

Request

GET/{organizationId}/{mandateId}/crm/passes/templates/{templateId}
curl --request GET 'https://cloud.campai.com/api/{organizationId}/{mandateId}/crm/passes/templates/{templateId}' \
  --header 'X-API-Key: YOUR_API_KEY'

Responses

This endpoint returns different response codes based on the request outcome.

200Successful response

Content-Type: application/json

ObjectId as string

namestringrequired

minLength: 1

maxLength: 40

descriptionstringrequired

maxLength: 100

targetstringrequired

Options:

walletprintwalletAndPrint

ObjectId as string

contactTypestringrequired

Options:

memberaddresscustomersponsorcontributoremployeesupplier
useRecognizableBarcodebooleanrequired
publishedAtstring | nullrequired

Additional properties are not allowed.

emailSubjectstringrequired

maxLength: 100

emailMessagestringrequired

maxLength: 1600

emailDaysBeforeinteger | nullrequired

minimum: 1

maximum: 365

Response

200
{
  "_id": "000000000000000000000001",
  "name": "string",
  "description": "string",
  "target": "wallet",
  "expressaPrintTemplate": "000000000000000000000001",
  "contactType": "member",
  "contactSegments": [
    "string"
  ],
  "useRecognizableBarcode": true,
  "publishedAt": "string",
  "statistics": {
    "pending": 0,
    "installed": 0,
    "uninstalled": 0,
    "printed": 0
  },
  "emailSubject": "string",
  "emailMessage": "string",
  "validFrom": {
    "literal": [
      1
    ]
  },
  "validTo": {
    "literal": [
      1
    ]
  },
  "emailDaysBefore": 1
}

400Invalid input data

Content-Type: application/json

The error information

messagestringrequired

The error message

codestringrequired

The error code

An array of issues that were responsible for the error

Response

400
{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

401Authorization not provided

Content-Type: application/json

The error information

messagestringrequired

The error message

codestringrequired

The error code

An array of issues that were responsible for the error

Response

401
{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

403Insufficient access

Content-Type: application/json

The error information

messagestringrequired

The error message

codestringrequired

The error code

An array of issues that were responsible for the error

Response

403
{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

404Not found

Content-Type: application/json

The error information

messagestringrequired

The error message

codestringrequired

The error code

An array of issues that were responsible for the error

Response

404
{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}

500Internal server error

Content-Type: application/json

The error information

messagestringrequired

The error message

codestringrequired

The error code

An array of issues that were responsible for the error

Response

500
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}