> ## 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 Dash Collection

> Gets a collection of dashboards for the current associate

NsApiSlow threshold: 5000 ms.



## OpenAPI

````yaml /openapi/agent/openapi-v3-DashAgent.json post /api/v1/Agents/Dash/GetDashCollection
openapi: 3.0.0
info:
  version: v1-Agents
  title: SuperOffice Agent API v1
  description: SuperOffice Agent API - DashAgent
  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/Dash/GetDashCollection:
    post:
      tags:
        - Dash_Agent
      summary: Get Dash Collection
      description: |-
        Gets a collection of dashboards for the current associate

        NsApiSlow threshold: 5000 ms.
      operationId: v1DashAgent_GetDashCollection
      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
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.DashCollection'
            text/json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.DashCollection'
            application/xml:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.DashCollection'
            text/xml:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.DashCollection'
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.DashCollection'
            application/merge-patch+json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.DashCollection'
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.CRM.Services.DashCollection:
      description: "Collection of dashboards for an associate\r\n<para />\r\nCarrier object for DashCollection.\r\nServices for the DashCollection Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IDashAgent\">Dash Agent</see>."
      type: object
      properties:
        Pinned:
          description: Dashboards pinned to the associate
          type: array
          items:
            $ref: '#/components/schemas/SuperOffice.CRM.Services.Dash'
        Favourites:
          description: The assocates favourite dashboards
          type: array
          items:
            $ref: '#/components/schemas/SuperOffice.CRM.Services.Dash'
        Other:
          description: Other dashboards
          type: array
          items:
            $ref: '#/components/schemas/SuperOffice.CRM.Services.Dash'
        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.Services.Dash:
      description: "Dashboard configuration\r\n<para />\r\nCarrier object for Dash.\r\nServices for the Dash Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IDashAgent\">Dash Agent</see>."
      type: object
      properties:
        DashboardId:
          format: int32
          description: Primary key
          type: integer
        UniqueId:
          description: GUID identifying a default dashboard from SuperOffice
          type: string
        Name:
          description: The name of this dashboard
          type: string
        Description:
          description: Detailed description
          type: string
        AssociateId:
          format: int32
          description: Associate who owns this dashboard
          type: integer
        Columns:
          format: int32
          description: How many columns there will be in the dashboard.
          type: integer
        Theme:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.DashTheme'
        VisibleForAll:
          format: int32
          description: True if visible for all
          type: integer
        VisibleForAssociates:
          description: Array of references to the visible for associates
          type: array
          items:
            format: int32
            type: integer
        VisibleForGroups:
          description: Array of references to the visible for groups
          type: array
          items:
            format: int32
            type: integer
        PinForAll:
          format: int32
          description: True if pinned for all
          type: integer
        PinForAssociates:
          description: Array of references to the pinned associates
          type: array
          items:
            format: int32
            type: integer
        PinForGroups:
          description: Array of references to the pinned groups
          type: array
          items:
            format: int32
            type: integer
        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.Services.DashTheme:
      description: "Dashboard theme configuration\r\n<para />\r\nCarrier object for DashTheme.\r\nServices for the DashTheme Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IDashAgent\">Dash Agent</see>."
      type: object
      properties:
        DashboardThemeId:
          format: int32
          description: Primary key
          type: integer
        Name:
          description: The name of this theme
          type: string
        Config:
          description: The JSON clob-formatted config
          type: string
        Rank:
          format: int32
          description: Rank order
          type: integer
        Client:
          description: Name of client(s) this theme is available to
          type: string
        Style:
          description: Style value - for example 'light' or 'dark'
          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.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.Dash GetDashCollectionRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Dash_GetDashCollectionRequest.md)
- [NSDashAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSDashAgent.md)
- [SuperOffice.WebApi.Agents.DashAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.DashAgent.md)
- [SuperOffice.WebApi.Agents.IDashAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IDashAgent.md)
- [NSDashCollection](/en/automation/crmscript/reference/CRMScript.NetServer.NSDashCollection.md)
- [Create Default Dash Collection](/en/api/reference/restful/agent/dash_agent/create-default-dash-collection.md)