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

# Generate Navigation Url

> This methods generates the navigation URL to be used to navigate to the panel

NsApiSlow threshold: 5000 ms.



## OpenAPI

````yaml /openapi/agent/openapi-v3-ListAgent.json post /api/v1/Agents/List/GenerateNavigationUrl
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/GenerateNavigationUrl:
    post:
      tags:
        - List_Agent
      summary: Generate Navigation Url
      description: >-
        This methods generates the navigation URL to be used to navigate to the
        panel


        NsApiSlow threshold: 5000 ms.
      operationId: v1ListAgent_GenerateNavigationUrl
      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.ListCarriers.GenerateNavigationUrlRequest
          text/json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.ListCarriers.GenerateNavigationUrlRequest
          application/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.ListCarriers.GenerateNavigationUrlRequest
          text/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.ListCarriers.GenerateNavigationUrlRequest
          application/x-www-form-urlencoded:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.ListCarriers.GenerateNavigationUrlRequest
          application/json-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.ListCarriers.GenerateNavigationUrlRequest
          application/merge-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.ListCarriers.GenerateNavigationUrlRequest
        description: VisibleIn, WindowName
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: string
            text/json:
              schema:
                type: string
            application/xml:
              schema:
                type: string
            text/xml:
              schema:
                type: string
            application/json-patch+json:
              schema:
                type: string
            application/merge-patch+json:
              schema:
                type: string
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.WebApi.v1.Carriers.ListCarriers.GenerateNavigationUrlRequest:
      description: >-
        GenerateNavigationUrl: This methods generates the navigation URL to be
        used to navigate to the panel
      type: object
      properties:
        VisibleIn:
          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
        WindowName:
          type: string

````

## Related topics

- [SuperOffice.WebApi.Data.List GenerateNavigationUrlRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.List_GenerateNavigationUrlRequest.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)
- [Enum Navigation](/en/automation/crmscript/reference/CRMScript.NetServer.Navigation.md)
- [EventData](/en/automation/crmscript/datatypes/eventdata-type.md)