GET /push/v1/message
Retrieves all messages currently defined within an account.
| Name | Type | Description | |
|---|---|---|---|
| $page | number | Page number to return from the paged results. Start with 1 and continue until you get zero results. Typically provided along with the $pagesize parameter. | |
| $pagesize | number | Number of results per page to return. Typically provided along with the $page parameter. | |
| $filter | string | Filter by a message's property using a simple operator and value. Valid filter properties are Message Type, Content Type, and Status. | |
| $orderBy | string | Determines which property to use for sorting, and also determines the direction in which to sort the data. |
The sort syntax is the message property name followed by the order direction, either asc or desc, with a space in between. Sort by multiple property names by separating each sequence with a comma. Valid sort properties are:
- id
- name
- statusid
- status
- scheduledDate
- applicationId
- application
- app
- campaign
- sendMethodId
- subject
- geofenceId
- createdDate
- lastUpdated
This example sorts by name in descending order: /push/v1/message?$orderBy=name asc.
Each filter is separated by %20. Any other special characters need to be url encoded.
| Operator | Description |
|---|---|
| eq | Equals. Compares numbers and strings. |
| neq | Is not equal to. Compares numbers and strings. |
| lt | Is less than. Compares numbers only. |
| lte | Is less than or equal to. Compares numbers only. |
| gt | Is greater than. Compares numbers only. |
| gte | Is greater than or equal to. Compares numbers only. |
| like | Is similar to. Compares strings only. |
Example Request
Example Response
If the request includes invalid values, the API returns a 400 response with details on the error.