Painéis

Listar painéis

get

Autorizações

Bearer

Parâmetros de consulta

TitlestringOpcional

Filtro por título do painel.

CreatedAt.Beforestring · date-timeOpcional

Limite superior de busca, sempre em fuso horário UTM.

CreatedAt.Afterstring · date-timeOpcional

Limite inferior de busca, sempre em fuso horário UTM.

UpdatedAt.Beforestring · date-timeOpcional

Limite superior de busca, sempre em fuso horário UTM.

UpdatedAt.Afterstring · date-timeOpcional

Limite inferior de busca, sempre em fuso horário UTM.

PageNumberinteger · int32 · máx: 2147483647Opcional

Número da página a ser obtida.

Default: 1

PageSizeinteger · int32 · mín: 1 · máx: 100Opcional

Tamanho da página a ser obtida.

Default: 15

OrderBystringOpcional

Nome do campo para ser utilizado como pivô da ordenação.

OrderDirectionstring · enumOpcional

Determina se a ordenação deve ser crescente ou decrescente.

Valores possíveis:

Respostas

200

Success

application/json

500

Server Error

application/json

get

/v1/panel

HTTPcURLJavaScriptPython

GET /crm/v1/panel HTTP/1.1
Host: api.helena.run
Authorization: YOUR_API_KEY
Accept: */*

{
  "pageNumber": 1,
  "pageSize": 15,
  "orderBy": "text",
  "orderDirection": "ASCENDING",
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2025-11-08T12:52:36.280Z",
      "updatedAt": "2025-11-08T12:52:36.280Z",
      "companyId": "123e4567-e89b-12d3-a456-426614174000",
      "archived": true,
      "scope": "COMPANY",
      "departmentIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ],
      "userId": "123e4567-e89b-12d3-a456-426614174000",
      "title": "text",
      "description": "text",
      "thumbnailId": "123e4567-e89b-12d3-a456-426614174000",
      "thumbnailFile": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "companyId": "123e4567-e89b-12d3-a456-426614174000",
        "userId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "extension": "text",
        "mimeType": "text",
        "type": "UNDEFINED",
        "publicUrl": "text",
        "publicUrlDownload": "text",
        "size": 1,
        "isThumbnail": true,
        "thumbnail": {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "publicUrl": "text"
        }
      },
      "key": "text",
      "overdueCardCount": 1,
      "stepTitles": [
        "text"
      ],
      "tags": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "createdAt": "2025-11-08T12:52:36.280Z",
          "updatedAt": "2025-11-08T12:52:36.280Z",
          "companyId": "123e4567-e89b-12d3-a456-426614174000",
          "panelId": "123e4567-e89b-12d3-a456-426614174000",
          "name": "text",
          "nameColor": "text",
          "bgColor": "text"
        }
      ],
      "steps": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "createdAt": "2025-11-08T12:52:36.280Z",
          "updatedAt": "2025-11-08T12:52:36.280Z",
          "companyId": "123e4567-e89b-12d3-a456-426614174000",
          "panelId": "123e4567-e89b-12d3-a456-426614174000",
          "archived": true,
          "position": 1,
          "title": "text",
          "isInitial": true,
          "isFinal": true,
          "cardCount": 1,
          "overdueCardCount": 1,
          "monetaryAmount": 1,
          "fields": [
            {
              "key": "text",
              "type": "DEFAULT_FIELD",
              "position": 1,
              "visible": true
            }
          ],
          "cards": {
            "pageNumber": 1,
            "pageSize": 15,
            "orderBy": "text",
            "orderDirection": "ASCENDING",
            "items": [
              {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "createdAt": "2025-11-08T12:52:36.280Z",
                "updatedAt": "2025-11-08T12:52:36.280Z",
                "archived": true,
                "companyId": "123e4567-e89b-12d3-a456-426614174000",
                "panelId": "123e4567-e89b-12d3-a456-426614174000",
                "panelTitle": "text",
                "stepId": "123e4567-e89b-12d3-a456-426614174000",
                "stepTitle": "text",
                "stepPhase": "NONE",
                "position": 1,
                "title": "text",
                "description": "text",
                "key": "text",
                "number": 1,
                "dueDate": "2025-11-08T12:52:36.280Z",
                "isOverdue": true,
                "tagIds": [
                  "123e4567-e89b-12d3-a456-426614174000"
                ],
                "sessionId": "123e4567-e89b-12d3-a456-426614174000",
                "monetaryAmount": 1,
                "responsibleUserId": "123e4567-e89b-12d3-a456-426614174000",
                "responsibleUser": {
                  "id": "123e4567-e89b-12d3-a456-426614174000",
                  "name": "text"
                },
                "contactIds": [
                  "123e4567-e89b-12d3-a456-426614174000"
                ],
                "contacts": [
                  {
                    "id": "123e4567-e89b-12d3-a456-426614174000",
                    "name": "text"
                  }
                ],
                "customFields": {
                  "ANY_ADDITIONAL_PROPERTY": null
                },
                "metadata": {
                  "ANY_ADDITIONAL_PROPERTY": null
                }
              }
            ],
            "totalItems": 1,
            "totalPages": 1,
            "hasMorePages": true
          }
        }
      ]
    }
  ],
  "totalItems": 1,
  "totalPages": 1,
  "hasMorePages": true
}

Obter por ID

get

Autorizações

Bearer

Parâmetros de rota

idstring · uuidObrigatório

ID do painel.

Parâmetros de consulta

Respostas

200

Success

application/json

500

Server Error

application/json

get

/v1/panel/{id}

HTTPcURLJavaScriptPython

GET /crm/v1/panel/{id} HTTP/1.1
Host: api.helena.run
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-11-08T12:52:36.280Z",
  "updatedAt": "2025-11-08T12:52:36.280Z",
  "companyId": "123e4567-e89b-12d3-a456-426614174000",
  "archived": true,
  "scope": "COMPANY",
  "departmentIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "title": "text",
  "description": "text",
  "thumbnailId": "123e4567-e89b-12d3-a456-426614174000",
  "thumbnailFile": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "companyId": "123e4567-e89b-12d3-a456-426614174000",
    "userId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "extension": "text",
    "mimeType": "text",
    "type": "UNDEFINED",
    "publicUrl": "text",
    "publicUrlDownload": "text",
    "size": 1,
    "isThumbnail": true,
    "thumbnail": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "publicUrl": "text"
    }
  },
  "key": "text",
  "overdueCardCount": 1,
  "stepTitles": [
    "text"
  ],
  "tags": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2025-11-08T12:52:36.280Z",
      "updatedAt": "2025-11-08T12:52:36.280Z",
      "companyId": "123e4567-e89b-12d3-a456-426614174000",
      "panelId": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "nameColor": "text",
      "bgColor": "text"
    }
  ],
  "steps": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2025-11-08T12:52:36.280Z",
      "updatedAt": "2025-11-08T12:52:36.280Z",
      "companyId": "123e4567-e89b-12d3-a456-426614174000",
      "panelId": "123e4567-e89b-12d3-a456-426614174000",
      "archived": true,
      "position": 1,
      "title": "text",
      "isInitial": true,
      "isFinal": true,
      "cardCount": 1,
      "overdueCardCount": 1,
      "monetaryAmount": 1,
      "fields": [
        {
          "key": "text",
          "type": "DEFAULT_FIELD",
          "position": 1,
          "visible": true
        }
      ],
      "cards": {
        "pageNumber": 1,
        "pageSize": 15,
        "orderBy": "text",
        "orderDirection": "ASCENDING",
        "items": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "createdAt": "2025-11-08T12:52:36.280Z",
            "updatedAt": "2025-11-08T12:52:36.280Z",
            "archived": true,
            "companyId": "123e4567-e89b-12d3-a456-426614174000",
            "panelId": "123e4567-e89b-12d3-a456-426614174000",
            "panelTitle": "text",
            "stepId": "123e4567-e89b-12d3-a456-426614174000",
            "stepTitle": "text",
            "stepPhase": "NONE",
            "position": 1,
            "title": "text",
            "description": "text",
            "key": "text",
            "number": 1,
            "dueDate": "2025-11-08T12:52:36.280Z",
            "isOverdue": true,
            "tagIds": [
              "123e4567-e89b-12d3-a456-426614174000"
            ],
            "sessionId": "123e4567-e89b-12d3-a456-426614174000",
            "monetaryAmount": 1,
            "responsibleUserId": "123e4567-e89b-12d3-a456-426614174000",
            "responsibleUser": {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "name": "text"
            },
            "contactIds": [
              "123e4567-e89b-12d3-a456-426614174000"
            ],
            "contacts": [
              {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "name": "text"
              }
            ],
            "customFields": {
              "ANY_ADDITIONAL_PROPERTY": null
            },
            "metadata": {
              "ANY_ADDITIONAL_PROPERTY": null
            }
          }
        ],
        "totalItems": 1,
        "totalPages": 1,
        "hasMorePages": true
      }
    }
  ]
}

Campos personalizados

get

Autorizações

Bearer

Parâmetros de rota

idstring · uuidObrigatório

ID do painel.

Parâmetros de consulta

NestedListbooleanOpcional

Determina a estrutura da lista retornada. Se verdadeiro, os campos serão retornados de forma aninhada, isto é, estruturado em grupos.

Default: false

Respostas

200

Success

application/json

500

Server Error

application/json

get

/v1/panel/{id}/custom-fields

HTTPcURLJavaScriptPython

GET /crm/v1/panel/{id}/custom-fields HTTP/1.1
Host: api.helena.run
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2025-11-08T12:52:36.280Z",
    "updatedAt": "2025-11-08T12:52:36.280Z",
    "parentId": "123e4567-e89b-12d3-a456-426614174000",
    "type": "GROUP",
    "entityType": "CONTACT",
    "scopeId": "123e4567-e89b-12d3-a456-426614174000",
    "companyId": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "key": "text",
    "position": 1,
    "required": true,
    "visible": true,
    "isValueRange": true,
    "options": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text"
      }
    ],
    "children": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "createdAt": "2025-11-08T12:52:36.280Z",
        "updatedAt": "2025-11-08T12:52:36.280Z",
        "parentId": "123e4567-e89b-12d3-a456-426614174000",
        "type": "GROUP",
        "entityType": "CONTACT",
        "scopeId": "123e4567-e89b-12d3-a456-426614174000",
        "companyId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "key": "text",
        "position": 1,
        "required": true,
        "visible": true,
        "isValueRange": true,
        "options": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text"
          }
        ],
        "children": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "createdAt": "2025-11-08T12:52:36.280Z",
            "updatedAt": "2025-11-08T12:52:36.280Z",
            "parentId": "123e4567-e89b-12d3-a456-426614174000",
            "type": "GROUP",
            "entityType": "CONTACT",
            "scopeId": "123e4567-e89b-12d3-a456-426614174000",
            "companyId": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text",
            "key": "text",
            "position": 1,
            "required": true,
            "visible": true,
            "isValueRange": true,
            "options": [
              {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "name": "text"
              }
            ],
            "children": "[Circular Reference]"
          }
        ]
      }
    ]
  }
]