> ## 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 Attachment Preview > Retrieve an attachment from ticket message. The returned data is intended to be used for a preview. The returned data is sanitized. NsApiSlow threshold: 2000 ms. ## OpenAPI ````yaml /openapi/agent/openapi-v3-TicketAgent.json post /api/v1/Agents/Ticket/GetAttachmentPreview 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/GetAttachmentPreview: post: tags: - Ticket_Agent summary: Get Attachment Preview description: "Retrieve an attachment from ticket message.\n\nThe returned data is intended to be used for a preview. The returned data is sanitized.\r\nNsApiSlow threshold: 2000 ms." operationId: v1TicketAgent_GetAttachmentPreview parameters: - 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 requestBody: content: application/json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.TicketCarriers.GetAttachmentPreviewRequest text/json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.TicketCarriers.GetAttachmentPreviewRequest application/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.TicketCarriers.GetAttachmentPreviewRequest text/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.TicketCarriers.GetAttachmentPreviewRequest application/x-www-form-urlencoded: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.TicketCarriers.GetAttachmentPreviewRequest application/json-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.TicketCarriers.GetAttachmentPreviewRequest application/merge-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.TicketCarriers.GetAttachmentPreviewRequest description: AttachmentId required: true responses: '200': description: OK content: application/json: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.AttachmentPreview text/json: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.AttachmentPreview application/xml: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.AttachmentPreview text/xml: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.AttachmentPreview application/json-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.AttachmentPreview application/merge-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.CRM.Services.AttachmentPreview security: - SuperOffice_Password: [] SuperId_Authentication: [] components: schemas: SuperOffice.WebApi.v1.Carriers.TicketCarriers.GetAttachmentPreviewRequest: description: >- GetAttachmentPreview: Retrieve an attachment from ticket message. The returned data is intended to be used for a preview. The returned data is sanitized. type: object properties: AttachmentId: format: int32 type: integer SuperOffice.CRM.Services.AttachmentPreview: description: "Service attachment data intended for preview purposes\r\n\r\nCarrier object for AttachmentPreview.\r\nServices for the AttachmentPreview Carrier is available from the Ticket Agent." type: object properties: Name: description: Name of the attachment file type: string MimeType: description: The mimetype of the attachment type: string Size: format: int32 description: Size of the attachment in bytes type: integer Content: format: byte description: Attachment data type: string EmailSubject: description: Subject of the attached RFC822 email. Null for non-RFC822 attachment type: string EmailFrom: description: >- From field of the attached RFC822 email. Null for non-RFC822 attachment type: string EmailTo: description: >- To field of the attached RFC822 email. Null for non-RFC822 attachment type: string EmailCc: description: >- Cc field of the attached RFC822 email. Null for non-RFC822 attachment type: string EmailDate: format: date-time description: >- Date of the attached RFC822 email. Default DateTime value for non-RFC822 attachment type: string EmailAttachmentsInfo: description: >- The attachments inside the attached RFC822 email. Empty array for non-RFC822 attachment type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.AttachmentEntity' 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.AttachmentEntity: description: "The Attachment carrier represent meta data for a Service attachment\r\n\r\nCarrier object for AttachmentEntity.\r\nServices for the AttachmentEntity Carrier is available from the Ticket Agent." type: object properties: AttachmentId: format: int32 description: The primary key (auto-incremented) type: integer Name: description: The filename for the attachment. type: string ContentType: description: >- The content type for the attachment (e.g. 'applaction/octet-stream' or 'application/vnd.openxmlformats-officedocument.wordprocessingml.document'). type: string AttSize: format: int32 description: The size (in bytes) for the attachment. type: integer InlineImage: description: True if this attachment is inlined in the html_body. type: boolean ContentId: description: The content_id of this attachment, used for inline images type: string AuthKey: description: The key used for authenticating access to this attachment. type: string IsSafeFileExtension: description: Is file considered to be safe (based on extension and settings) type: boolean 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 - [SuperOffice.WebApi.Data.Ticket GetAttachmentPreviewRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Ticket_GetAttachmentPreviewRequest.md) - [SuperOffice.WebApi.Agents.ITicketAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.ITicketAgent.md) - [SuperOffice.WebApi.Agents.TicketAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.TicketAgent.md) - [Get Preview Attachment Stream](/en/api/reference/restful/agent/ticket_agent/get-preview-attachment-stream.md) - [Get Preview Attachment From Id](/en/api/reference/restful/agent/email_agent/get-preview-attachment-from-id.md) - [Get Preview Attachment From Doc Id](/en/api/reference/restful/agent/email_agent/get-preview-attachment-from-doc-id.md)