> ## Documentation Index
> Fetch the complete documentation index at: https://docs.herondata.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get user's company overview layout



## OpenAPI

````yaml https://app.herondata.io/swagger get /api/users/company_overview_layout
openapi: 3.0.0
info:
  contact:
    email: support@herondata.io
    name: Support
  title: Heron Data API
  version: '2021-07-19'
servers:
  - description: Production
    url: https://app.herondata.io
security:
  - ApiKeyAuth:
      - key_XXX
externalDocs:
  description: Read Tutorial
  url: https://docs.herondata.io/
paths:
  /api/users/company_overview_layout:
    get:
      tags:
        - Users
      summary: Get user's company overview layout
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/CompanyOverviewLayoutSchema'
                type: array
          description: OK
      security:
        - ApiKeyAuth: []
components:
  schemas:
    CompanyOverviewLayoutSchema:
      properties:
        group_name:
          type: string
        id:
          description: A unique id used to reference the group
          type: string
        widgets:
          items:
            $ref: '#/components/schemas/Widget'
          type: array
      required:
        - group_name
        - id
        - widgets
      type: object
    Widget:
      properties:
        id:
          description: A unique id used to reference the widget
          type: string
        scorecard_metric_date_range:
          enum:
            - latest
            - last_30_days
            - last_90_days
            - last_120_days
            - last_180_days
            - last_365_days
            - next_30_days
            - next_60_days
            - next_90_days
            - next_180_days
            - last_1_calendar_months
            - last_3_calendar_months
            - last_4_calendar_months
            - last_6_calendar_months
            - last_12_calendar_months
            - last_15_calendar_months
            - last_24_calendar_months
            - last_1_full_calendar_months
            - last_2_full_calendar_months
            - last_3_full_calendar_months
            - last_6_full_calendar_months
            - last_12_full_calendar_months
            - last_60_days
            - last_45_days
            - last_2_calendar_months
          type: string
        scorecard_metric_label:
          type: string
        type:
          enum:
            - scorecard_metric
            - heron_score
            - loan_revenue_ratio
            - deposit_trends_ratio
          type: string
      required:
        - id
        - type
      type: object
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: x-api-key
      type: apiKey

````