> ## 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 Board View Settings For Selection

> Get BoardViewSettings by associate id and selection id

NsApiSlow threshold: 1000 ms.



## OpenAPI

````yaml /openapi/agent/openapi-v3-SelectionAgent.json post /api/v1/Agents/Selection/GetBoardViewSettingsForSelection
openapi: 3.0.0
info:
  version: v1-Agents
  title: SuperOffice Agent API v1
  description: SuperOffice Agent API - SelectionAgent
  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/Selection/GetBoardViewSettingsForSelection:
    post:
      tags:
        - Selection_Agent
      summary: Get Board View Settings For Selection
      description: |-
        Get BoardViewSettings by associate id and selection id

        NsApiSlow threshold: 1000 ms.
      operationId: v1SelectionAgent_GetBoardViewSettingsForSelection
      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.SelectionCarriers.GetBoardViewSettingsForSelectionRequest
          text/json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.SelectionCarriers.GetBoardViewSettingsForSelectionRequest
          application/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.SelectionCarriers.GetBoardViewSettingsForSelectionRequest
          text/xml:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.SelectionCarriers.GetBoardViewSettingsForSelectionRequest
          application/x-www-form-urlencoded:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.SelectionCarriers.GetBoardViewSettingsForSelectionRequest
          application/json-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.SelectionCarriers.GetBoardViewSettingsForSelectionRequest
          application/merge-patch+json:
            schema:
              $ref: >-
                #/components/schemas/SuperOffice.WebApi.v1.Carriers.SelectionCarriers.GetBoardViewSettingsForSelectionRequest
        description: AssociateId, SelectionId
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.BoardViewSettingsBase
            text/json:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.BoardViewSettingsBase
            application/xml:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.BoardViewSettingsBase
            text/xml:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.BoardViewSettingsBase
            application/json-patch+json:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.BoardViewSettingsBase
            application/merge-patch+json:
              schema:
                $ref: >-
                  #/components/schemas/SuperOffice.CRM.Services.BoardViewSettingsBase
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.WebApi.v1.Carriers.SelectionCarriers.GetBoardViewSettingsForSelectionRequest:
      description: >-
        GetBoardViewSettingsForSelection: Get BoardViewSettings by associate id
        and selection id
      type: object
      properties:
        AssociateId:
          format: int32
          type: integer
        SelectionId:
          format: int32
          type: integer
    SuperOffice.CRM.Services.BoardViewSettingsBase:
      description: "Board view settings.\r\n<para />\r\nCarrier object for BoardViewSettingsBase.\r\nServices for the BoardViewSettingsBase Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.ISelectionAgent\">Selection Agent</see>."
      type: object
      properties:
        BoardViewSettingsId:
          format: int32
          description: Primary key
          type: integer
        EntityType:
          description: The kind of board view entity these settings belong to
          enum:
            - None
            - Sale
            - Project
            - ContactPerson
          type: string
        AssociateId:
          format: int32
          description: The associate this board view settings belongs to (0 for all)
          type: integer
        SelectionId:
          format: int32
          description: The selection this board view settings belongs to
          type: integer
        HideEmptyGroups:
          description: Do not show groups with no members/elements if this is true
          type: boolean
        GroupBy:
          description: Column name to group on
          type: string
        SubGroupBy:
          description: Column name to group on
          type: string
        SortBy:
          description: Column name to sort on
          type: string
        SortDesc:
          description: True if the sort is descending
          type: boolean
        SumBy:
          description: Column name to sum on
          type: string
        ColorBy:
          description: Column name to color on
          type: string
        Filters:
          description: Column names to filter on, comma separated
          type: string

````

## Related topics

- [SuperOffice.WebApi.Data.Selection GetBoardViewSettingsForSelectionRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Selection_GetBoardViewSettingsForSelectionRequest.md)
- [SuperOffice.WebApi.Agents.SelectionAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.SelectionAgent.md)
- [SuperOffice.WebApi.Agents.ISelectionAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.ISelectionAgent.md)
- [Get Board View Settings](/en/api/reference/restful/agent/selection_agent/get-board-view-settings.md)
- [Save Board View Settings](/en/api/reference/restful/agent/selection_agent/save-board-view-settings.md)
- [Delete Board View Settings](/en/api/reference/restful/agent/selection_agent/delete-board-view-settings.md)
