> ## 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 Task Menu

> Gets a TaskMenu object.

NsApiSlow threshold: 5000 ms.



## OpenAPI

````yaml /openapi/agent/openapi-v3-ListAgent.json post /api/v1/Agents/List/GetTaskMenu
openapi: 3.0.0
info:
  version: v1-Agents
  title: SuperOffice Agent API v1
  description: SuperOffice Agent API - ListAgent
  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/List/GetTaskMenu:
    post:
      tags:
        - List_Agent
      summary: Get Task Menu
      description: |-
        Gets a TaskMenu object.

        NsApiSlow threshold: 5000 ms.
      operationId: v1ListAgent_GetTaskMenu
      parameters:
        - name: taskMenuId
          in: query
          description: The identifier of the TaskMenu 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.TaskMenu'
            text/json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.TaskMenu'
            application/xml:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.TaskMenu'
            text/xml:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.TaskMenu'
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.TaskMenu'
            application/merge-patch+json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.TaskMenu'
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.CRM.Services.TaskMenu:
      description: "Configurable Menu Items are items that will be merged into menus in given area and entity\r\n<para />\r\nCarrier object for TaskMenu.\r\nServices for the TaskMenu Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IListAgent\">List Agent</see>."
      type: object
      properties:
        TaskMenuId:
          format: int32
          description: Primary key
          type: integer
        Name:
          description: The list item
          type: string
        Tooltip:
          description: Tooltip or other description
          type: string
        TableName:
          description: The name of entity that this task item can be used at
          type: string
        Area:
          description: >-
            Can be Task or other that can identify which menu recipe to merge
            the item into
          type: string
        UrlOrSoprotocol:
          description: The url or soprotocol
          type: string
        TaskType:
          description: Type of task item Url, SoProtocol or CRMScript.
          enum:
            - None
            - Url
            - CrmScript
            - SoProtocol
          type: string
        CrmScriptId:
          format: int32
          description: The CRMScript or Macro which will be run task item is selected.
          type: integer
        ShowInClient:
          description: Show task list item in which clients (web, mobile)
          enum:
            - None
            - Web
            - Mobile
          type: string
        ArchiveBehaviour:
          description: None, rightclick on, multiselect
          enum:
            - None
            - InArchives
            - MultiSelectInArchives
          type: string
        Rank:
          format: int32
          description: Rank order
          type: integer
        Encoding:
          description: Encoding for url
          enum:
            - Unknown
            - None
            - ANSI
            - Unicode
          type: string
        ProgId:
          description: >-
            String key that can be used to uniquely retrieve the task menu;
            particularly useful for partners and others who do not wish to store
            database ID's
          type: string
        Deleted:
          description: True if deleted
          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

- [Get Task Menu By Prog Id](/en/api/reference/restful/agent/list_agent/get-task-menu-by-prog-id.md)
- [SuperOffice.WebApi.Data.TaskMenu](/en/api/reference/webapi/SuperOffice.WebApi.Data.TaskMenu.md)
- [SuperOffice.WebApi.Data.List GetTaskMenuByProgIdRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.List_GetTaskMenuByProgIdRequest.md)
- [SuperOffice.WebApi.Agents.IListAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IListAgent.md)
- [SuperOffice.WebApi.Agents.ListAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.ListAgent.md)
- [Delete Task Menu](/en/api/reference/restful/agent/list_agent/delete-task-menu.md)