---
title: "Obter por ID"
method: GET
path: "/v1/panel/{id}"
tags: ["Painéis"]
---

# Obter por ID

`GET /v1/panel/{id}`

## Path parameters

- `id` string, uuid, required

## Query parameters

- `IncludeDetails` string[]

## Response `200`

Success

- PublicPanelDTO
  - `id` string, uuid
  - `createdAt` string, date-time
  - `updatedAt` string, date-time
  - `companyId` string, uuid
  - `archived` boolean
  - `scope` 'COMPANY' | 'DEPARTMENT' | 'USER'
  - `departmentIds` string[], nullable
  - `userId` string, uuid, nullable
  - `title` string, nullable
  - `description` string, nullable
  - `thumbnailId` string, uuid, nullable
  - `thumbnailFile` PublicFileDTO
    - `id` string, uuid
    - `companyId` string, uuid, nullable
    - `userId` string, uuid, nullable
    - `name` string, nullable
    - `extension` string, nullable
    - `mimeType` string, nullable
    - `type` 'UNDEFINED' | 'PDF' | 'EXCEL' | 'WORD' | 'IMAGE' | 'AUDIO' | 'VIDEO'
    - `publicUrl` string, nullable
    - `publicUrlDownload` string, nullable
    - `size` integer
    - `isThumbnail` boolean
    - `thumbnail` PublicFileThumbnailDTO
      - `id` string, uuid
      - `publicUrl` string, nullable
  - `key` string, nullable
  - `overdueCardCount` integer, nullable
  - `stepTitles` string[], nullable
  - `tags` PublicPanelTagDTO[], nullable
    - `id` string, uuid
    - `createdAt` string, date-time
    - `updatedAt` string, date-time
    - `companyId` string, uuid, nullable
    - `panelId` string, uuid
    - `name` string, nullable
    - `nameColor` string, nullable
    - `bgColor` string, nullable
  - `steps` PublicPanelStepDTO[], nullable
    - `id` string, uuid
    - `createdAt` string, date-time
    - `updatedAt` string, date-time
    - `companyId` string, uuid
    - `panelId` string, uuid
    - `archived` boolean
    - `position` number, double
    - `title` string, nullable
    - `isInitial` boolean
    - `isFinal` boolean
    - `cardCount` integer, nullable
    - `overdueCardCount` integer, nullable
    - `monetaryAmount` number, double, nullable
    - `fields` PublicPanelStepFieldDTO[], nullable
      - `key` string, nullable
      - `type` 'DEFAULT_FIELD' | 'CUSTOM_FIELD'
      - `position` integer
      - `visible` boolean, nullable
    - `cards` PublicPanelCardDTOPublicPageListDTO
      - `pageNumber` integer — Número da página a ser obtida.
      - `pageSize` integer — Tamanho da página a ser obtida.
      - `orderBy` string, nullable — Nome do campo para ser utilizado como pivô da ordenação.
      - `orderDirection` 'ASCENDING' | 'DESCENDING', nullable — Determina se a ordenação deve ser crescente ou decrescente.
      - `items` PublicPanelCardDTO[], nullable
        - `id` string, uuid
        - `createdAt` string, date-time
        - `updatedAt` string, date-time
        - `companyId` string, uuid
        - `panelId` string, uuid
        - `panelTitle` string, nullable
        - `stepId` string, uuid
        - `stepTitle` string, nullable
        - `stepPhase` 'NONE' | 'INITIAL' | 'FINAL', nullable
        - `position` number, double
        - `title` string, nullable
        - `description` string, nullable
        - `key` string, nullable
        - `number` integer
        - `dueDate` string, date-time, nullable
        - `isOverdue` boolean
        - `tagIds` string[], nullable
        - `sessionId` string, uuid, nullable
        - `monetaryAmount` number, double, nullable
        - `responsibleUserId` string, uuid, nullable
        - `responsibleUser` PublicPanelCardResponsibleUserDTO
          - `id` string, uuid
          - `name` string, nullable
        - `contactIds` string[], nullable
        - `contacts` PublicPanelCardContactDTO[], nullable
          - `id` string, uuid
          - `name` string, nullable
        - `customFields` object, nullable
        - `metadata` object, nullable
        - `archived` boolean
      - `totalItems` integer
      - `totalPages` integer
      - `hasMorePages` boolean
  - `type` 'MANAGEMENT' | 'SALES'
  - `autoLossDays` integer, nullable

## Other responses

- `500` — Server Error

---

[API](https://skmtc.net/helena/apis/core.md) · [All operations](https://skmtc.net/helena/apis/core/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/helena/core/versions/811b2cdd2ec2/schema)