> ## 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 Ext App Entity

> Gets a ExtAppEntity object.

NsApiSlow threshold: 5000 ms.



## OpenAPI

````yaml /openapi/agent/openapi-v3-ListAgent.json post /api/v1/Agents/List/GetExtAppEntity
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/GetExtAppEntity:
    post:
      tags:
        - List_Agent
      summary: Get Ext App Entity
      description: |-
        Gets a ExtAppEntity object.

        NsApiSlow threshold: 5000 ms.
      operationId: v1ListAgent_GetExtAppEntity
      parameters:
        - name: extAppEntityId
          in: query
          description: The identifier of the ExtAppEntity 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.ExtAppEntity'
            text/json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.ExtAppEntity'
            application/xml:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.ExtAppEntity'
            text/xml:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.ExtAppEntity'
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.ExtAppEntity'
            application/merge-patch+json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.ExtAppEntity'
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.CRM.Services.ExtAppEntity:
      description: "The ext app entity contains information on an external application\r\n<para />\r\nCarrier object for ExtAppEntity.\r\nServices for the ExtAppEntity Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IListAgent\">List Agent</see>."
      type: object
      properties:
        ExtAppId:
          format: int32
          description: The identity of the external app
          type: integer
        Name:
          description: The name of the web panel
          type: string
        Tooltip:
          description: The tooltip of the web panel
          type: string
        Deleted:
          description: True if the application is marked as deleted
          type: boolean
        Rank:
          format: int32
          description: The rank of the application
          type: integer
        Filename:
          description: Filename of the programfile
          type: string
        Parameters:
          description: <template variable> <other template variable>
          type: string
        Workdir:
          description: >-
            Directory set to current when loading the application, if different
            from application's own
          type: string
        ShowState:
          description: >-
            The application is shown in which state Minimized, Maximized or
            Restored
          enum:
            - Minimized
            - Maximized
            - Default
            - ToolBar
            - AddressBar
            - StatusBar
            - MenuBar
          type: string
        VisibleIn:
          description: The application is visible in
          enum:
            - Invisible
            - ToolboxMenu
            - NavigatorButton
            - ViewMenu
            - SelectionTaskCard
            - ContactCard
            - ContactArchive
            - ProjectCard
            - ProjectArchive
            - SaleCard
            - PersonCard
            - ActivityDialog
            - DocumentDialog
            - BrowserPanel
            - ContSelectionTask
            - AppntSelectionTask
            - SaleSelectionTask
            - DocSelectionTask
            - ProjSelectionTask
            - CompanyMinicard
            - ProjectMinicard
            - DiaryMinicard
            - SelectionMinicard
            - ButtonPanelTask
            - AppointmentDialogTask
            - SaleDialogTask
            - DocumentDialogTask
            - PersonDialogTask
            - SaleMinicard
            - SaleArchive
            - AppntSelectionShadowTask
            - SaleSelectionShadowTask
            - DocSelectionShadowTask
            - ProjSelectionShadowTask
            - DiaryArchive
            - SelectionContactArchive
            - SelectionProjectArchive
            - SelectionSaleArchive
            - SelectionAppointmentArchive
            - SelectionDocumentArchive
            - ContSelectionCustomTask
            - AppntSelectionCustomTask
            - SaleSelectionCustomTask
            - DocSelectionCustomTask
            - ProjSelectionCustomTask
            - CustomArchiveMiniCard
            - SelectionCard
            - ReportMinicard
            - QuoteDialog
            - QuoteDialogTask
            - QuoteDialogArchive
            - QuoteLineDialogTask
            - QuoteLineDialog
            - QuoteLineSelectionMainTask
            - QuoteLineSelectionShadowTask
            - SelectionQuoteLineArchive
            - QuoteLineSelectionCustomTask
            - FindSystem
            - MailingSelectionTask
            - ContactSelectionMailingsTask
            - AppointmentSelectionMailingsTask
            - SaleSelectionMailingsTask
            - DocumentSelectionMailingsTask
            - ProjectSelectionMailingsTask
            - QuoteLineSelectionMailingsTask
            - TopPanelNewMenu
            - Dashboard
            - PersonArchive
            - PersonMinicard
            - CompanyCardTask
            - ProjectCardTask
            - TicketCard
            - TicketMinicard
            - CustomObjectCard
            - CustomObjectArchive
          type: string
        OnCentral:
          description: Is the application visible when user is on central database
          type: boolean
        OnSatellite:
          description: Is the application visible when user is on a satellite
          type: boolean
        OnTravel:
          description: Is the application visible when user is on travel
          type: boolean
        OnSalesMarketingPocket:
          description: Is the webpanel visible when user is on pocket client
          type: boolean
        ShowInMenuBar:
          description: Does the application have a menu bar
          type: boolean
        ShowInToolBar:
          description: Does the webpanel have a toolbar
          type: boolean
        ShowInAddressBar:
          description: Does the webpanel have an address bar
          type: boolean
        ShowInStatusBar:
          description: Does the webpanel have a status bar
          type: boolean
        Icon:
          format: int32
          description: The id of the icon of the external app
          type: integer
        WaitToFinish:
          description: True if the application shall wait for fininsh event
          type: boolean
        ExecuteOnEvent:
          description: Events that cause automatic execution of this app
          enum:
            - Never
            - Logon
            - Logoff
            - LocalUpdate
            - Wait
          type: string
        Path:
          description: Path where the programfile is located; if empty, PATH is used
          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

- [SuperOffice.WebApi.Data.ExtAppEntity](/en/api/reference/webapi/SuperOffice.WebApi.Data.ExtAppEntity.md)
- [NSListAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSListAgent.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)
- [NSExtAppEntity](/en/automation/crmscript/reference/CRMScript.NetServer.NSExtAppEntity.md)
- [Save Ext App Entity](/en/api/reference/restful/agent/list_agent/save-ext-app-entity.md)