> ## 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 System Messages > Retrieves a list of system messages for a specific associate. NsApiSlow threshold: 2000 ms. ## OpenAPI ````yaml /openapi/agent/openapi-v3-DiagnosticsAgent.json post /api/v1/Agents/Diagnostics/GetSystemMessages openapi: 3.0.0 info: version: v1-Agents title: SuperOffice Agent API v1 description: SuperOffice Agent API - DiagnosticsAgent 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/Diagnostics/GetSystemMessages: post: tags: - Diagnostics_Agent summary: Get System Messages description: |- Retrieves a list of system messages for a specific associate. NsApiSlow threshold: 2000 ms. operationId: v1DiagnosticsAgent_GetSystemMessages 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.DiagnosticsCarriers.GetSystemMessagesRequest text/json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.DiagnosticsCarriers.GetSystemMessagesRequest application/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.DiagnosticsCarriers.GetSystemMessagesRequest text/xml: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.DiagnosticsCarriers.GetSystemMessagesRequest application/x-www-form-urlencoded: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.DiagnosticsCarriers.GetSystemMessagesRequest application/json-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.DiagnosticsCarriers.GetSystemMessagesRequest application/merge-patch+json: schema: $ref: >- #/components/schemas/SuperOffice.WebApi.v1.Carriers.DiagnosticsCarriers.GetSystemMessagesRequest description: AssociateId required: true responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.SystemMessage' text/json: schema: type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.SystemMessage' application/xml: schema: type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.SystemMessage' text/xml: schema: type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.SystemMessage' application/json-patch+json: schema: type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.SystemMessage' application/merge-patch+json: schema: type: array items: $ref: '#/components/schemas/SuperOffice.CRM.Services.SystemMessage' security: - SuperOffice_Password: [] SuperId_Authentication: [] components: schemas: SuperOffice.WebApi.v1.Carriers.DiagnosticsCarriers.GetSystemMessagesRequest: description: >- GetSystemMessages: Retrieves a list of system messages for a specific associate. type: object properties: AssociateId: format: int32 type: integer SuperOffice.CRM.Services.SystemMessage: description: "System Message to be displayed to a user\r\n\r\nCarrier object for SystemMessage.\r\nServices for the SystemMessage Carrier is available from the Diagnostics Agent." type: object properties: MessageId: format: int32 description: Primary key type: integer AssociateId: format: int32 description: The associate that is the target of this message type: integer OnlineappId: format: int32 description: The online app that owns this message type: integer SystemMessageId: description: Message identifier, used for message update or removal type: string MarkdownMessage: description: Markdown message to be displayed to user type: string Expire: format: date-time description: The date and time the message expires in UTC. type: string Type: description: 'Type of message, example: info, warning, error' enum: - Unspecified - Info - Warning - Error 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 - [System Messages](/en/developer-portal/best-practices/system-messages.md) - [SuperOffice.WebApi.Data.Diagnostics GetSystemMessagesRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Diagnostics_GetSystemMessagesRequest.md) - [SuperOffice.WebApi.Agents.DiagnosticsAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.DiagnosticsAgent.md) - [Remove System Message](/en/api/reference/restful/agent/diagnostics_agent/remove-system-message.md) - [Enum values for SystemMessageType](/en/database/tables/enums/systemmessagetype.md) - [Send System Message](/en/api/reference/restful/agent/diagnostics_agent/send-system-message.md)