This page was automatically generated from tracezilla’s Swagger API documentation 2026-01-26

GET /messages/{messageId}

Get message

Description

Returns message

Parameters (path)

Name Required Description Values
messageId required Target message.  

Parameters (query)

Name Required Description Values
include optional The resources that can be included in this request, delimited by a comma: primary_document, message_expenses, sender_team, sender_user, recipient_partner  

Responses

200

successful operation

Response content JSON schema 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150

{
  "properties": {
    "properties": {
      "id": {
        "description": "Id of the record",
        "type": "string",
        "format": "uuid",
        "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
      },
      "body": {
        "description": "No description is available",
        "type": "string",
        "format": "string",
        "example": "A string"
      },
      "dest_entity_id": {
        "description": "No description is available",
        "type": "string",
        "format": "string",
        "example": "A string"
      },
      "dest_model_name": {
        "description": "No description is available",
        "type": "string",
        "format": "string",
        "example": "A string"
      },
      "open_at": {
        "description": "No description is available",
        "type": "string",
        "format": "date-time",
        "example": "2019-01-01T13:25:32.312Z"
      },
      "open_count": {
        "description": "No description is available",
        "format": "",
        "example": ""
      },
      "read_at": {
        "description": "No description is available",
        "type": "string",
        "format": "date-time",
        "example": "2019-01-01T13:25:32.312Z"
      },
      "read_count": {
        "description": "No description is available",
        "format": "",
        "example": ""
      },
      "recipient_email": {
        "description": "No description is available",
        "type": "string",
        "format": "string",
        "example": "A string"
      },
      "recipient_email_cc": {
        "description": "No description is available",
        "type": "string",
        "format": "string",
        "example": "A string"
      },
      "recipient_email_bcc": {
        "description": "No description is available",
        "type": "string",
        "format": "string",
        "example": "A string"
      },
      "recipient_partner_id": {
        "description": "No description is available",
        "type": "string",
        "format": "uuid",
        "example": "be3233c4-c0a2-4f47-a62a-303492c20ba6"
      },
      "recipient_team_id": {
        "description": "No description is available",
        "type": "integer",
        "format": "int32",
        "example": 1234
      },
      "recipient_user_id": {
        "description": "No description is available",
        "type": "integer",
        "format": "int32",
        "example": 1234
      },
      "secret_expires": {
        "description": "No description is available",
        "type": "string",
        "format": "date-time",
        "example": "2019-01-01T13:25:32.312Z"
      },
      "secret_key": {
        "description": "No description is available",
        "type": "string",
        "format": "string",
        "example": "A string"
      },
      "sender_team_id": {
        "description": "No description is available",
        "type": "integer",
        "format": "int32",
        "example": 1234
      },
      "sender_user_id": {
        "description": "No description is available",
        "type": "integer",
        "format": "int32",
        "example": 1234
      },
      "sent_at": {
        "description": "No description is available",
        "type": "string",
        "format": "date-time",
        "example": "2019-01-01T13:25:32.312Z"
      },
      "source_entity_id": {
        "description": "No description is available",
        "type": "string",
        "format": "string",
        "example": "A string"
      },
      "source_model_name": {
        "description": "No description is available",
        "type": "string",
        "format": "string",
        "example": "A string"
      },
      "subject": {
        "description": "No description is available",
        "type": "string",
        "format": "string",
        "example": "A string"
      },
      "created_at": {
        "description": "The time when the record was created in UTC date & time (Iso8601 ZuluString)",
        "type": "string",
        "format": "date-time",
        "example": "2019-01-01T13:25:32.312Z"
      },
      "updated_at": {
        "description": "The time when the record was last updated in UTC date & time (Iso8601 ZuluString)",
        "type": "string",
        "format": "date-time",
        "example": "2020-01-01T13:25:32.312Z"
      }
    },
    "type": "object"
  },
  "type": "object"
}

406

not acceptable

500

internal server error