List the variables of the email templates

Returns the placeholders that the subject and message of the email templates accept, such as defaults.subject in GET /v1/companies/{company_id}/email-configuration. Write a placeholder, braces included, wherever the value should appear: it is replaced when the email is sent.

Scope: the catalogue is the same for every credential and does not depend on any account or company, so the operation takes no identifier.
Unknown placeholders: a placeholder that is not listed is sent as written.

Closed catalogue. This collection is fixed and bounded: it carries no pagination, it takes no page/limit, and every response holds the whole set.

Authorization

AuthorizationBearer <token>

Keys are prefixed beel_sk_, and each one carries the scopes it was created with: a key short of the scope an operation needs is answered 403. The scope an operation requires is shown next to its title, and the full catalogue lives in the Scopes reference.

Keys are created from the BeeL dashboard. They are secret credentials: do not share them or commit them to source control.

In: header

Response Body

application/json

curl -X GET "https://app.beel.es/api/v1/email-template-variables"

curl -X GET "https://app.beel.es/api/v1/email-template-variables"

{
  "success": true,
  "data": {
    "variables": [
      {
        "key": "invoiceNumber",
        "placeholder": "{invoiceNumber}",
        "description": "Invoice number"
      },
      {
        "key": "customerName",
        "placeholder": "{customerName}",
        "description": "Customer name"
      }
    ]
  }
}

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication is required to access this resource"
  },
  "meta": {
    "timestamp": "2025-01-15T10:30:00Z",
    "request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
  }
}

{
  "success": false,
  "error": {
    "code": "FORBIDDEN",
    "message": "You do not have permission to access this resource"
  },
  "meta": {
    "timestamp": "2025-01-15T10:30:00Z",
    "request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
  }
}

{
  "success": false,
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Too many requests. Please try again in 60 seconds."
  },
  "meta": {
    "timestamp": "2025-01-15T10:30:00Z",
    "request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
  }
}

{
  "success": false,
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error"
  },
  "meta": {
    "timestamp": "2025-01-15T10:30:00Z",
    "request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
  }
}

{
  "success": false,
  "error": {
    "code": "UNSUPPORTED_MEDIA_TYPE",
    "message": "Unsupported media type: text/plain. Supported: application/json"
  },
  "meta": {
    "timestamp": "2025-01-15T10:30:00Z",
    "request_id": "4bf92f3577b34da6a3ce929d0e0e4736"
  }
}

List the variables of the email templates

Authorization

Response Body

200application/json

401application/json

403application/json

429application/json

500application/json

defaultapplication/json

application/json

application/json

application/json

application/json

application/json

application/json