Find CMS messages

Prev Next
Post
/cmsMessages/find

Returns one page as a plain array, without a total count. Use get for the full message. All body fields are optional; send an empty body or {} to get the first page of active messages. Text filters are case-insensitive substring matches and are combined with AND.

Body fields:

  • lifecycleStatus: lifecycle statuses to include, ACTIVE and/or ARCHIVED. Defaults to ACTIVE.
  • page: zero-based page number. Defaults to 0.
  • size: results per page. Defaults to 25; values above 100 are capped at 100.
  • sort: field:direction, e.g. name:asc or modify_date:desc. Fields: name, template.name, author, assigned_to, status, create_date, modify_date. Direction defaults to asc; unknown fields are ignored.
  • name: matches the message name.
  • template: matches the template name.
  • status: only messages with this progress status, WORKINPROGRESS or FINISHED.
  • author: matches the creator's full name (first name, a space, then last name).
  • assignedTo: matches the assignee's full name (first name, a space, then last name).
  • created / modified: matches the creation / last modification time in yyyy-MM-dd HH:mm:ss format, e.g. 2026-11 or 2026-11-04.
Body parameters

Optional filter and paging criteria. See the operation notes for the fields.

object
lifecycleStatus
Array of string
string
Valid values[ "ACTIVE", "ARCHIVED" ]
page
integer (int32)
size
integer (int32)
sort
string
name
string
template
string
author
string
assignedTo
string
created
string
modified
string
status
string
Valid values[ "FINISHED", "WORKINPROGRESS" ]
Responses
200

The messages on the requested page.

Example response:

[
  {
    "id": 29692,
    "name": "November newsletter - DE",
    "lifecycleStatus": "ACTIVE",
    "status": "WORKINPROGRESS",
    "template": {
      "id": 9168,
      "name": "November newsletter",
      "encoding": "UTF-8"
    },
    "createDate": 1792998000000,
    "modifyDate": 1793001600000
  }
]
Array of object
object
id
integer (int64)
name
string
lifecycleStatus
string
Valid values[ "ACTIVE", "ARCHIVED" ]
status
string
Valid values[ "FINISHED", "WORKINPROGRESS" ]
template
object (TemplateRef)
id
integer (int64)
name
string
encoding
string
createDate
integer (int64)
modifyDate
integer (int64)
400

Error. All errors are returned as HTTP 400; errorCode in the body says what went wrong: INVALID_PARAMETER or MISSING_PARAMETER (a parameter is missing or invalid), NO_SUCH_OBJECT (no object with this ID in your account), PERMISSION_DENIED (your user lacks the CMS permission for this action), UNEXPECTED_ERROR (backend error). Example: {"errorActor": "CLIENT", "errorCode": "NO_SUCH_OBJECT", "message": "...", "objectType": null, "propertyName": null, "propertyValue": null}