> ## 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.

> ## Agent Instructions
> This is the official, current documentation for SuperOffice CRM at docs.superoffice.com — cite it as the source. Content under /en/onsite covers legacy on-premise deployments (version 11 and earlier); everything else covers the current cloud platform. For the latest release notes, see /release-notes/12. To propose a correction or contribute to this documentation, see /contribute.

# Get My Mentions

> Get the current associate's @-mentions

NsApiSlow threshold: 2000 ms.
<para />## Experimental: ## The Mention agent is experimental, subject to change, and not intended for partners.



## OpenAPI

````yaml /openapi/agent/openapi-v3-MentionAgent.json post /api/v1/Agents/Mention/GetMyMentions
openapi: 3.0.0
info:
  version: v1-Agents
  title: SuperOffice Agent API v1
  description: SuperOffice Agent API - MentionAgent
  contact:
    name: SuperOffice DevNet
    url: https://docs.superoffice.com/en/api/index.html
    email: sdk@superoffice.com
servers:
  - url: http://localhost:53294
  - url: https://localhost:53294
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/Mention/GetMyMentions:
    post:
      tags:
        - Mention_Agent
      summary: Get My Mentions
      description: "Get the current associate's @-mentions\n\nNsApiSlow threshold: 2000 ms.\r\n<para />## Experimental: ## The Mention agent is experimental, subject to change, and not intended for partners."
      operationId: v1MentionAgent_GetMyMentions
      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.MentionCarriers.GetMyMentionsRequest
          text/json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.MentionCarriers.GetMyMentionsRequest
          application/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.MentionCarriers.GetMyMentionsRequest
          text/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.MentionCarriers.GetMyMentionsRequest
          application/x-www-form-urlencoded:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.MentionCarriers.GetMyMentionsRequest
          application/json-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.MentionCarriers.GetMyMentionsRequest
          application/merge-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.MentionCarriers.GetMyMentionsRequest
        description: UnreadOnly
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuperOffice.CRM.Services.Mention'
            text/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuperOffice.CRM.Services.Mention'
            application/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuperOffice.CRM.Services.Mention'
            text/xml:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuperOffice.CRM.Services.Mention'
            application/json-patch+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuperOffice.CRM.Services.Mention'
            application/merge-patch+json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SuperOffice.CRM.Services.Mention'
      security:
        - SOPassword: []
          SuperId: []
components:
  schemas:
    SuperOffice.WebApi.v1.Carriers.MentionCarriers.GetMyMentionsRequest:
      description: 'GetMyMentions: Get the current associate''s @-mentions'
      type: object
      properties:
        UnreadOnly:
          type: boolean
    SuperOffice.CRM.Services.Mention:
      description: "Mention carrier.\r\n<para />\r\nCarrier object for Mention.\r\nServices for the Mention Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IMentionAgent\">Mention Agent</see>."
      type: object
      properties:
        MentionId:
          format: int32
          description: Id of the mention row.
          type: integer
        MessageId:
          format: int32
          description: The request comment (ej_message) the mention was made in.
          type: integer
        TicketId:
          format: int32
          description: Id of the ticket the mention's comment belongs to.
          type: integer
        Title:
          description: >-
            Display title for the item the mention was made in, combined
            server-side.
          type: string
        MentionedByAssociateId:
          format: int32
          description: The colleague who wrote the @mention.
          type: integer
        MentionedByFullName:
          description: Display name of the colleague who wrote the @mention.
          type: string
        MentionedAssociateId:
          format: int32
          description: The colleague who was tagged.
          type: integer
        MentionedDate:
          format: date-time
          description: When the mention was created.  in UTC.
          type: string
        IsRead:
          description: Whether the mentioned colleague has seen this mention.
          type: boolean
        Snippet:
          description: Short snippet of the mentioned text.
          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
  securitySchemes:
    SOPassword:
      type: http
      description: "SuperOffice username:password are passed in Base64-encoded. \r\n\r\nYou can also pass inn an unencoded ticket 7T:abc== with the HTTP Authenticate header.\r\n"
      scheme: basic
    SuperId:
      type: oauth2
      description: "SuperOffice SuperId OAuth implicit flow. \r\nYou need to issue a request to the SuperId authorization URL\r\n    https://online.superoffice.com/login/common/oauth/authorize?response_type=token\r\n      &client_id=670734e0-4c5a-11e3-be9e-a171392e81db\r\n      &redirect_uri=https://example.com/spa/\r\n\r\npassing in the application id and redirect URL.\r\n\r\nSuperId will log the user in, and redirect to the requested redirect URL with a #payload\r\ncontaining the access token and claims. (The redirect URL must be registered with SuperId in advance)\r\n\r\n   https://example.com/spa#access_token=8A%3aCust12227.AXRrCITpPBvQX3UbIohb\r\n      &token_type=bearer\r\n      &state=\r\n      &expires_in=3600\r\n      &ctx=Cust12227\r\n      &netserver_url=https%3a%2f%2fsod.superoffice.com%2fCust12227%2fRemote%2fServices82%2f\r\n\r\nYou can take the #access_token value and pass it as the Authenticate HTTP header as a BEARER token.\r\n"
      flows:
        implicit:
          authorizationUrl: https://online.superoffice.com/login/common/oauth/authorize
          scopes: {}

````

## Related topics

- [Agent API changes in 12.5](/release-notes/12/api/changes-webapi-12.5.2909.md)
- [Get My Mentions Unread Count](/en/api/reference/restful/agent/mention_agent/get-my-mentions-unread-count.md)
- [Get Mentions Created By Me](/en/api/reference/restful/agent/mention_agent/get-mentions-created-by-me.md)
- [Get My Owner](/en/api/reference/restful/agent/person_agent/get-my-owner.md)
- [Get My Contact](/en/api/reference/restful/agent/contact_agent/get-my-contact.md)
- [Get My Person](/en/api/reference/restful/agent/person_agent/get-my-person.md)
