Messages: Message details
GET /websites/:website_id/messages/:message_id
Get the details of an existing message by ID.
| Attribute | Details |
|---|---|
website_id
Required
|
The ID of the website the message originated from. |
message_id
Required
|
The ID of the message to be retrieved. |
includes
|
Comma separated list of additional fields to include in the response. Available includes are |
Sample Curl Request
curl "https://api.firespring.com/websites/4/messages/51" \
-u your-api-key: \
-H "Firespring-Api-Version: 1" \
-X GET \
-G \
-d includes="form, form_submission, payment_transactions"
Sample Response
{
"id": 51,
"object": "message",
"date_created": "2018-05-31T15:22:10+00:00",
"event_submission": 5839845,
"file": 0,
"form": {
"object": "form",
"id": 10119690,
"title": "Registration Form"
},
"form_submission": {
"object": "form_submission",
"fields": {
"f10119691": {
"object": "form_submission_field",
"id": "f10119691",
"field_type": "name",
"label": "Name",
"values": {
"prefix": "",
"first": "John",
"middle": "",
"last": "Doe",
"suffix": ""
},
"formatted_value": "John Doe"
},
"f10119692": {
"object": "form_submission_field",
"id": "f10119692",
"field_type": "email",
"label": "Email",
"values": {
"submitted_value": "john.doe@xyzcorp.com",
"display_value": ""
},
"formatted_value": "john.doe@xyzcorp.com"
},
"f10119693": {
"object": "form_submission_field",
"id": "f10119693",
"field_type": "phone",
"label": "Phone",
"values": {
"country_code": "",
"number": "1112223333",
"extension": ""
},
"formatted_value": "+1 1112223333"
}
}
},
"message_tracking_number": "4415297e3af8c",
"message_type": "event_management",
"online_proof": 0,
"order": 0,
"payment_transactions": {
"object": "list",
"data": [
{
"object": "payment_transaction",
"id": 7679878,
"amount": 2500,
"currency": "usd",
"date_created": "2018-05-31T15:22:10+00:00",
"is_recurring": false,
"payment_type": "credit_card",
"test_mode": false,
"transaction_id": "09a3dc19d8924da88d391d8cb78a7988",
"transaction_status": "captured",
"transaction_type": "payment"
}
]
},
"portal": 0,
"user": 0
}
Sample Curl Request
curl "https://api.firespring.com/websites/4/messages/45" \
-u your-api-key: \
-H "Firespring-Api-Version: 1" \
-X GET \
-G \
-d includes="file, form, form_submission"
Sample Response
{
"id": 45,
"object": "message",
"date_created": "2018-05-30T19:30:58+00:00",
"event_submission": 0,
"file": null,
"form": {
"object": "form",
"id": 10119111,
"title": "General Contact"
},
"form_submission": {
"object": "form_submission",
"fields": {
"f10119112": {
"object": "form_submission_field",
"id": "f10119112",
"field_type": "name",
"label": "Your Name",
"values": {
"prefix": "",
"first": "John",
"middle": "",
"last": "Doe",
"suffix": ""
},
"formatted_value": "John Doe"
},
"f10119098": {
"object": "form_submission_field",
"id": "f10119098",
"field_type": "email",
"label": "E-mail Address",
"values": {
"submitted_value": "john.doe@xyzcorp.com",
"display_value": ""
},
"formatted_value": "john.doe@xyzcorp.com"
},
"f10119120": {
"object": "form_submission_field",
"id": "f10119120",
"field_type": "textarea",
"label": "Questions",
"values": {
"submitted_value": "Test question"
},
"formatted_value": "Test question"
},
"f10119121": {
"object": "form_submission_field",
"id": "f10119121",
"field_type": "textarea",
"label": "Comments",
"values": {
"submitted_value": "Test comment"
},
"formatted_value": "Test comment"
}
}
},
"message_tracking_number": "4415297e3af8c",
"message_type": "general_contact",
"online_proof": 0,
"order": 0,
"portal": 0,
"user": 0
}
Sample Curl Request
curl "https://api.firespring.com/websites/4/messages/52" \
-u your-api-key: \
-H "Firespring-Api-Version: 1" \
-X GET \
-G \
-d includes="form, form_submission, order, order.items, portal, payment_transactions, user"
Sample Response
{
"id": 52,
"object": "message",
"date_created": "2018-05-31T15:33:38+00:00",
"event_submission": 0,
"file": 0,
"form": {
"object": "form",
"id": 10119026,
"title": "Catalog Order"
},
"form_submission": {
"object": "form_submission",
"fields": {
"f10119027": {
"object": "form_submission_field",
"id": "f10119027",
"field_type": "name",
"label": "Name",
"values": {
"prefix": "",
"first": "John",
"middle": "",
"last": "Doe",
"suffix": ""
},
"formatted_value": "John Doe"
},
"f10119029": {
"object": "form_submission_field",
"id": "f10119029",
"field_type": "address",
"label": "Address",
"values": {
"line": "3232 Corporation Street",
"line2": "",
"line3": "",
"city": "Lincoln",
"state": "NE",
"postal_code": "68516",
"country": "US"
},
"formatted_value": "3232 Corporation Street, Lincoln, NE, 68516, US"
},
"f10119030": {
"object": "form_submission_field",
"id": "f10119030",
"field_type": "phone",
"label": "Phone Number",
"values": {
"country_code": "",
"number": "1112222202",
"extension": ""
},
"formatted_value": "+1 1112222202"
},
"f10119032": {
"object": "form_submission_field",
"id": "f10119032",
"field_type": "email",
"label": "E-mail Address",
"values": {
"submitted_value": "john.doe@xyzcorp.com",
"display_value": ""
},
"formatted_value": "john.doe@xyzcorp.com"
},
"f10119033": {
"object": "form_submission_field",
"id": "f10119033",
"field_type": "textarea",
"label": "Additional Details",
"values": {
"submitted_value": ""
},
"formatted_value": ""
}
}
},
"message_tracking_number": "4415297e3af8c",
"message_type": "general_contact",
"online_proof": 0,
"order": {
"object": "order",
"id": 5894857,
"amount_paid": 5985,
"content_catalog": 10119035,
"currency": "usd",
"date_created": "2018-05-31T15:33:38+00:00",
"is_pay_later": false,
"items": {
"object": "list",
"data": [
{
"object": "order_item",
"id": 6,
"catalog_item": 379013,
"content_catalog": 10119035,
"date_created": "2018-05-31T15:33:38+00:00",
"description": "Ballpoint pens have smooth-flowing ink that makes writing even, smooth and clear. These disposable pens offer 40 percent longer writing life without messy refills.",
"exempt_from_shipping": false,
"is_taxable": true,
"pricing": {
"object": "order_item_pricing",
"unit": 1995,
"volume": 1995,
"subtotal": 5985
},
"portal": 1147329,
"quantity": 3,
"shipment": 0,
"short_description": "Ballpoint Pens",
"sku": "PEN-001",
"status": "ordered",
"tax_class": 91442,
"tax_percentage": 0,
"title": "Pens",
"weight": 1.1
}
]
},
"message": 52,
"order_type": "catalog",
"portal": 1147329,
"pricing": {
"object": "order_pricing",
"shipping": 0,
"shipping_discount": 0,
"subtotal": 5985,
"subtotal_discount": 0,
"tax": 0,
"total": 5985
},
"promo_code": null,
"shipping_tax_percentage": 0,
"status": "new",
"user": 11
},
"payment_transactions": {
"object": "list",
"data": [
{
"object": "payment_transaction",
"id": 546525,
"amount": 5985,
"currency": "usd",
"date_created": "2018-05-31T15:33:38+00:00",
"is_recurring": false,
"payment_type": "credit_card",
"test_mode": false,
"transaction_id": "09a3dc19d8924da88d391d8cb78a7988",
"transaction_status": "captured",
"transaction_type": "payment"
}
]
},
"portal": {
"object": "portal",
"id": 1147329,
"title": "XYZ Corporation"
},
"user": {
"object": "website_user",
"id": 11,
"third_party_identifier": "",
"username": "xyzcorp"
}
}