# Retrieve broadcast messages

Retrieves a list of broadcast messages.

Endpoint: GET /broadcast-messages
Version: latest
Security: SecretApiKey, JWT

## Query parameters:

  - `limit` (integer)
    Limits the number of collection items to be returned.

  - `offset` (integer)
    Specifies the starting point within the collection of items to be returned.

  - `sort` (array)
    Sorts and orders the collection of items. To sort in descending
order, prefix with . Multiple fields can be sorted by separating each with .

  - `filter` (string)
    Filters the collection items. This field requires
a special format. Use  for multiple allowed values.  Use  for multiple fields.

For more information, see
Using filter with collections.

## Response 200 fields (application/json):

  - `id` (string)
    ID of the broadcast message.
    Example: "mail_bcst_0YV8XW5EXWDVEAP64XP8CY2X40"

  - `filter` (string,null)
    Use this filter to select customers during broadcast message processing.

This field uses the same syntax as the  filter,
but without the  prefix. Examples: , .

> : Do not URL encode the filter value.
    Example: "firstName:John;lastName:Doe"

  - `title` (string)
    Title of the message. This title displays in reports.

  - `messages` (array, required)
    List of messages.

  - `messages.id` (string)
    ID of the message.

  - `messages.version` (string)
    Version number of the message.
Use this field to distinguish between multiple messages by name and version number.
If there are no versions, this field is empty.

  - `messages.weight` (integer)
    Weight distribution value that is assigned to a template for a split test.
Each template in a split test can be assigned a weight.
The higher the weight value, the more likely the message template is used.

The split test algorithm does not assess locale when making a weighted template selection.
    Example: 75

  - `messages.templates` (array, required)
    Split test templates.

Use split tests to determine which content is most effective.
Split tests send variations of the same message to different customers or leads.
You can then send the winning message to the remaining customers or leads.

  - `messages.templates.from` (string, required)
    Email address of the sender.

>  This value must be a verified email address.

To verify an email address:
  1. [Create an email delivery setting](https://www.rebilly.com/catalog/all/email-delivery-settings/postemaildeliverysetting/).
  In the response, you receive the email and a token.
  1. [Verify the email delivery](https://www.rebilly.com/catalog/all/email-delivery-settings/putemaildeliverysettingsverification/) by passing the token as the path parameter.
    Example: "example@example.com"

  - `messages.templates.subject` (string, required)
    Subject of the message.
The use of template placeholders is permitted for this field.
    Example: "Demonstration subject"

  - `messages.templates.text` (string, required)
    Text body of the message.
To use content from the  field, leave this field empty.
The use of template placeholders is permitted for this field.
    Example: "Demonstration text"

  - `messages.templates.html` (string, required)
    HTML body of the message.
To use content from the  field, leave this field empty.
The use of template placeholders is permitted for this field.
    Example: "<p>Demonstration text</p>"

  - `messages.templates.locale` (string, required)
    Language locale identifier in [RFC 5646](https://tools.ietf.org/html/rfc5646) format.
    Example: "fr-FR"

  - `splitTestStartTime` (string,null)
    Date and time when the split test messages are scheduled to send.

  - `startSendingTime` (string, required)
    Date and time when the message is scheduled to send.

  - `status` (string)
    Status of the broadcast message.
    Enum: "draft", "sending", "sent", "archived"

  - `createdTime` (string)
    Date and time which is set automatically when the resource is created.

  - `updatedTime` (string)
    Date and time which updates automatically when the resource is updated.

  - `_links` (array)
    Related links.

  - `_links.href` (string)
    Link URL.

  - `_links.rel` (string)
    Type of link.
    Enum: "self"

## Response 401 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.

## Response 403 fields (application/json):

  - `status` (integer)
    HTTP status code.

  - `type` (string)
    Problem type in the form of a [URI](https://tools.ietf.org/html/rfc3986) reference.
It should provide human-readable documentation for the problem type.
When this member is not present, its value is assumed to be "about:blank".

  - `title` (string)
    Short, human-readable summary of the problem type.
Other than for the purposes of localization, this should not change from occurrence to occurrence of the problem.

  - `detail` (string)
    Human-readable explanation that is specific to this occurrence of the problem.

  - `instance` (string)
    URI reference that identifies the specific occurrence of the problem.
It may or may not yield further information if dereferenced.