> ## Documentation Index > Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Ticket Message > Gets a TicketMessage object. NsApiSlow threshold: 2000 ms. ## OpenAPI ````yaml /openapi/agent/openapi-v3-TicketAgent.json post /api/v1/Agents/Ticket/GetTicketMessage openapi: 3.0.0 info: version: v1-Agents title: SuperOffice Agent API v1 description: SuperOffice Agent API - TicketAgent contact: name: SuperOffice DevNet url: https://docs.superoffice.com/en/api/index.html email: sdk@superoffice.com servers: - url: http://localhost:56350 - url: https://localhost:56350 security: [] tags: [] externalDocs: description: >- The SuperOffice DevNet Community has more documentation, examples, and discussion forums. url: https://community.superoffice.com/en/developer/ paths: /api/v1/Agents/Ticket/GetTicketMessage: post: tags: - Ticket_Agent summary: Get Ticket Message description: |- Gets a TicketMessage object. NsApiSlow threshold: 2000 ms. operationId: v1TicketAgent_GetTicketMessage parameters: - name: ticketMessageId in: query description: The identifier of the TicketMessage object required: true schema: format: int32 type: integer - name: $select in: query description: >- Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category". Default = show all fields. required: false schema: type: string - name: Accept-Language in: header description: >- Convert string references and multi-language values into a specified language (iso2) code. required: false schema: type: string - name: SO-Language in: header description: >- Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value. required: false schema: type: string - name: SO-Culture in: header description: >- Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set. required: false schema: type: string - name: SO-TimeZone in: header description: >- Specify the timezone code that you would like date/time responses converted to. required: false schema: type: string - name: SO-AppToken in: header description: >- The application token that identifies the partner app. Used when calling Online WebAPI from a server. required: false schema: type: string responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.TicketMessage' text/json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.TicketMessage' application/xml: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.TicketMessage' text/xml: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.TicketMessage' application/json-patch+json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.TicketMessage' application/merge-patch+json: schema: $ref: '#/components/schemas/SuperOffice.CRM.Services.TicketMessage' security: - SuperOffice_Password: [] SuperId_Authentication: [] components: schemas: SuperOffice.CRM.Services.TicketMessage: description: "The TicketMessage carrier is used for representing a service ticket message\r\n\r\nCarrier object for TicketMessage.\r\nServices for the TicketMessage Carrier is available from the Ticket Agent." type: object properties: TicketMessageId: format: int32 description: The primary key (auto-incremented) type: integer CreatedAt: format: date-time description: When the message was posted. type: string Slevel: description: The securitylevel of the message. enum: - Unknown - Internal - External type: string Important: description: If this message is important or not. type: boolean Author: description: >- A string representing the author of the message. Could be a user's name, or a persons email address. type: string PersonId: format: int32 description: Primary key type: integer PersonFullName: description: >- Get the persons full name (internal name used in clients for employees). type: string ContactId: format: int32 description: Primary key type: integer ContactName: description: Contact name type: string ContactDepartment: description: Department type: string NumAttachments: format: int32 description: Number of attachments in the message type: integer EmailHeader: description: The email header is saved in this field as raw text type: string MessageHeaders: description: >- Contains the message headers, like To, Cc, Bcc information, or custom headers type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.TicketMessageHeader' Language: description: The language this message is in, based on some kind of analysis type: string Sentiment: format: int32 description: >- Sentiment index, 100 = completely happy; -100 = suicidally unhappy; 0 = no idea type: integer SentimentConfidence: format: int32 description: Confidence of sentiment index, 0 = no idea, 100 = completely sure type: integer CreatedBy: format: int32 description: >- The id of the user who posted the message. The value 1 (system user) for externally posted messages. type: integer ChangedAt: format: date-time description: When the message was changed. type: string Badge: description: Badge to explicitly determine how a message was generated enum: - Unknown - Reply - Forward - Comment - Incoming - Outgoing type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Services.TicketMessageHeader: description: "Contains information about a header connected to a ticket message\r\n\r\nCarrier object for TicketMessageHeader." type: object properties: Id: format: int32 description: Id type: integer Name: description: >- The name of the header. This can for example be To, Cc or other custom headers that is set up in Service type: string Value: description: >- The value of the header. Can for example be an email address, or a custom header extracted from emails type: string StdItem: description: >- If this has a value, it indicates that a standard header text from the language database should be used - and witch one to use enum: - None - Forward - UnnamedAttachmentBlocked - NoAutoReply - SentAutoReplyToCustomersA - SentAutoReplyToCustomersB - CustomerReadFAQ - ReplyTemplate type: string StdItemCol: description: >- If this is 1, concatenate the standard item text with header name field, if 2 use header value field instead. If this col is 0, use the empty field - preferably the value column. enum: - None - Name - Value type: string TableRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight' FieldProperties: description: >- Field property dictionary mapping field names to field access rights. type: object additionalProperties: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty' SuperOffice.CRM.Security.TableRight: description: "Wraps a table right together with an explanatory reason.\r\nCode can indicate why access is restricted." type: object properties: Mask: type: string Reason: type: string SuperOffice.CRM.Security.FieldProperty: description: >- Class holding properties like field length, field type about a field in the carrier. type: object properties: FieldRight: $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldRight' FieldType: type: string FieldLength: format: int32 description: '' type: integer SuperOffice.CRM.Security.FieldRight: description: "Wraps the field right together with an explanatory reason.\r\nAlso adds logical operators to the field rights so that they can be easily combined." type: object properties: Mask: type: string Reason: type: string ```` ## Related topics - [NSTicketMessage](/en/automation/crmscript/reference/CRMScript.NetServer.NSTicketMessage.md) - [Get Ticket Message Entities](/en/api/reference/restful/agent/ticket_agent/get-ticket-message-entities.md) - [Get Ticket Message Entity](/en/api/reference/restful/agent/ticket_agent/get-ticket-message-entity.md) - [Get Ticket Message With Options](/en/api/reference/restful/agent/ticket_agent/get-ticket-message-with-options.md) - [Get Ticket Message With Embedded Data](/en/api/reference/restful/agent/ticket_agent/get-ticket-message-with-embedded-data.md) - [Http Get Get Ticket Message With Embedded Data](/en/api/reference/restful/rest/ticketmessage/http-get-get-ticket-message-with-embedded-data.md)