Messages: List messages

GET /websites/:website_id/messages

Gets a list of messages.

Attribute	Details
`website_id` Required `integer`	The ID of the website the message originated from.
`count` `integer`	Maximum number of messages to return. Value can be between `1` and `100`. Default is `100`.
`date_end` `date`	Only return messages that were created before this date. The date should be specified in the YYYY-MM-DD format (e.g., `2018-01-01`).
`date_start` `date`	Only return messages that were created after this date. The date should be specified in the YYYY-MM-DD format (e.g., `2018-01-01`).
`direction` `string`	Return messages sorted in ascending or descending order. Valid options are `asc` and `desc`. Default is `desc`.
`includes` `string`	Comma separated list of additional fields to include in the response. Available includes are `file`, `form`, `form_submission`, `order`, `payment_transactions`, `portal`, and `user`.
`message_type` `string`	Only return messages of this type. Possible values are `content_online_proof`, `enfocus_file_upload`, `event_management`, `file_transfer`, `file_transfer_form`, `general_contact`, `jobready`, `landing_page_conversion`, `online_estimate`, `online_order`, `online_payment`, `online_proof_form`, `prayer_request`, and `system_notice`.
`page` `integer`	The page number of results to return. Defaults to page `1`.
`search` `string`	Search for messages that match the provided search string. Searches the `message_tracking_number` and `form.title` fields.
`sort` `string`	The field to sort the messages by. Possible values are `message_tracking_number`, `form.title`, and `date_created`. Defaults to `date_created`.

Sample Curl Request

curl "https://api.firespring.com/websites/4/messages" \
    -u your-api-key: \
    -H "Firespring-Api-Version: 1" \
    -X GET \
    -G \
    -d count="3" \
    -d page="1" \
    -d includes="user"

Sample Response

{
    "object": "list",
    "data": [
        {
            "id": 52,
            "object": "message",
            "date_created": "2018-05-31T15:33:38+00:00",
            "event_submission": 0,
            "file": 0,
            "form": 10119026,
            "message_tracking_number": "4415297e3af8c",
            "message_type": "online_order",
            "online_proof": 0,
            "order": 7,
            "portal": 1147329,
            "user": {
                "object": "website_user",
                "id": 11,
                "third_party_identifier": "",
                "username": "xyzcorp"
            }
        },
        {
            "id": 51,
            "object": "message",
            "date_created": "2018-05-31T15:22:10+00:00",
            "event_submission": 5839845,
            "file": 0,
            "form": 10119690,
            "message_tracking_number": "4415297e3af8c",
            "message_type": "event_management",
            "online_proof": 0,
            "order": 0,
            "portal": 0,
            "user": null
        },
        {
            "id": 45,
            "object": "message",
            "date_created": "2018-05-30T19:30:58+00:00",
            "event_submission": 0,
            "file": 0,
            "form": 10119111,
            "message_tracking_number": "4415297e3af8c",
            "message_type": "general_contact",
            "online_proof": 0,
            "order": 0,
            "portal": 0,
            "user": null
        }
    ],
    "meta": {
        "pagination": {
            "total": 49,
            "count": 3,
            "per_page": 3,
            "current_page": 1,
            "total_pages": 17
        }
    }
}