Cards

Listar

get

Listagem paginada de cards.

Autorizações
Parâmetros de consulta
PanelIdstring · uuidObrigatório

ID do painel.

StepIdstring · uuidOpcional

Filtro por ID da etapa.

ContactIdstring · uuidOpcional

Filtro por ID do contato.

ResponsibleUserIdstring · uuidOpcional

Filtro por ID do responsável.

TextFilterstringOpcional

Filtro textual. A busca é realizada nos atributos textuais relevantes do item.

IncludeArchivedbooleanOpcional

Incluir itens arquivados. Por padrão, não são incluídos na listagem.

Default: false
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
get
/v1/panel/card
GET /crm/v1/panel/card?PanelId=123e4567-e89b-12d3-a456-426614174000 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:33:27.604Z",
      "updatedAt": "2025-11-08T12:33:27.604Z",
      "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:33:27.604Z",
      "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
}

Criar

post
Autorizações
Corpo
stepIdstring · uuidObrigatório

ID da etapa do painel onde o item deverá ser inserido.

titlestring · mín: 1 · máx: 500Obrigatório

Título do item.

descriptionstring | nuloOpcional

Descrição do item.

positionnumber · double | nuloOpcional

Posição do item na etapa.

dueDatestring · date-time | nuloOpcional

Data de vencimento do item.

responsibleUserIdstring · uuid | nuloOpcional

ID do usuário responsável pelo item.

tagIdsstring · uuid[] | nuloOpcional

IDss das etiquetas atribuídas.

tagNamesstring[] | nuloOpcional

Nomes das etiquetas atribuídas. Este campo será ignorado caso TagIds seja definido.

contactIdsstring[] | nuloOpcional

IDs dos contatos relacionados ao item.

sessionIdstring · uuid | nuloOpcional

ID da conversa relacionada ao item.

monetaryAmountnumber · double | nuloOpcional

Valor monetário atribuído ao item.

Respostas
200

Success

application/json
post
/v1/panel/card
POST /crm/v1/panel/card HTTP/1.1
Host: api.helena.run
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 448

{
  "stepId": "123e4567-e89b-12d3-a456-426614174000",
  "title": "text",
  "description": "text",
  "position": 1,
  "dueDate": "2025-11-08T12:33:27.604Z",
  "responsibleUserId": "123e4567-e89b-12d3-a456-426614174000",
  "tagIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "tagNames": [
    "text"
  ],
  "contactIds": [
    "text"
  ],
  "sessionId": "123e4567-e89b-12d3-a456-426614174000",
  "monetaryAmount": 1,
  "customFields": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": null
  }
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-11-08T12:33:27.604Z",
  "updatedAt": "2025-11-08T12:33:27.604Z",
  "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:33:27.604Z",
  "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
  }
}

Obter por ID

get
Autorizações
Parâmetros de rota
idstring · uuidObrigatório

ID do card.

Parâmetros de consulta
Respostas
200

Success

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

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-11-08T12:33:27.604Z",
  "updatedAt": "2025-11-08T12:33:27.604Z",
  "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:33:27.604Z",
  "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
  }
}

Atualizar

put
Autorizações
Parâmetros de rota
idstringObrigatório

ID do card.

Corpo
stepIdstring · uuid | nuloOpcional

ID da etapa do painel para onde o item deverá ser movido.

titlestring | nuloOpcional

Título do item.

descriptionstring | nuloOpcional

Descrição do item.

positionnumber · double | nuloOpcional

Posição do item na etapa.

dueDatestring · date-time | nuloOpcional

Data de vencimento do item.

responsibleUserIdstring · uuid | nuloOpcional

ID do usuário responsável pelo item.

tagIdsstring · uuid[] | nuloOpcional

IDss das etiquetas atribuídas.

tagNamesstring[] | nuloOpcional

Nomes das etiquetas atribuídas. Este campo será ignorado caso TagIds seja definido.

contactIdsstring · uuid[] | nuloOpcional

IDs dos contatos relacionados ao item.

sessionIdstring · uuid | nuloOpcional

ID da conversa relacionada ao item.

monetaryAmountnumber · double | nuloOpcional

Valor monetário atribuído ao item.

archivedboolean | nuloOpcional

Determina o status de arquivamento do item.

Respostas
200

Success

application/json
put
/v2/panel/card/{id}
PUT /crm/v2/panel/card/{id} HTTP/1.1
Host: api.helena.run
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 516

{
  "fields": [
    "StepId"
  ],
  "stepId": "123e4567-e89b-12d3-a456-426614174000",
  "title": "text",
  "description": "text",
  "position": 1,
  "dueDate": "2025-11-08T12:33:27.604Z",
  "responsibleUserId": "123e4567-e89b-12d3-a456-426614174000",
  "tagIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "tagNames": [
    "text"
  ],
  "contactIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "sessionId": "123e4567-e89b-12d3-a456-426614174000",
  "monetaryAmount": 1,
  "archived": true,
  "customFields": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": null
  }
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-11-08T12:33:27.604Z",
  "updatedAt": "2025-11-08T12:33:27.604Z",
  "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:33:27.604Z",
  "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
  }
}

Duplicar

post
Autorizações
Parâmetros de rota
idstring · uuidObrigatório

ID do card.

Corpo
copyToStepIdstring · uuid | nuloOpcional

ID da etapa de destino, pode ser uma etapa do mesmo painel ou de outro painel. Se vazio, mantem a cópia na mesma etapa.

Respostas
200

Success

application/json
post
/v1/panel/card/{id}/duplicate
POST /crm/v1/panel/card/{id}/duplicate HTTP/1.1
Host: api.helena.run
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 117

{
  "copyToStepId": "123e4567-e89b-12d3-a456-426614174000",
  "options": {
    "archiveOriginalCard": true,
    "fields": [
      "Undefined"
    ]
  }
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-11-08T12:33:27.604Z",
  "updatedAt": "2025-11-08T12:33:27.604Z",
  "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:33:27.604Z",
  "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
  }
}

Listar anotações

get

Listagem paginada de anotações.

Autorizações
Parâmetros de rota
cardIdstring · uuidObrigatório

ID do card.

Parâmetros de consulta
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:
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.

Respostas
200

Success

application/json
get
/v1/panel/card/{cardId}/note
GET /crm/v1/panel/card/{cardId}/note 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:33:27.604Z",
      "updatedAt": "2025-11-08T12:33:27.604Z",
      "companyId": "123e4567-e89b-12d3-a456-426614174000",
      "panelId": "123e4567-e89b-12d3-a456-426614174000",
      "cardId": "123e4567-e89b-12d3-a456-426614174000",
      "userId": "123e4567-e89b-12d3-a456-426614174000",
      "text": "text",
      "files": [
        {
          "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"
          }
        }
      ]
    }
  ],
  "totalItems": 1,
  "totalPages": 1,
  "hasMorePages": true
}

Adicionar anotação

post
Autorizações
Parâmetros de rota
cardIdstring · uuidObrigatório

ID do card.

Corpo
textstring | nuloOpcional

Texto da anotação.

fileUrlsstring[] | nuloOpcional

URL pública de algum arquivo que deseja-se anexar à anotação. O tamanho máximo permitido para um arquivo é de 25MB.

Respostas
200

Success

application/json
post
/v1/panel/card/{cardId}/note
POST /crm/v1/panel/card/{cardId}/note HTTP/1.1
Host: api.helena.run
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "text": "text",
  "fileUrls": [
    "text"
  ]
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-11-08T12:33:27.604Z",
  "updatedAt": "2025-11-08T12:33:27.604Z",
  "companyId": "123e4567-e89b-12d3-a456-426614174000",
  "panelId": "123e4567-e89b-12d3-a456-426614174000",
  "cardId": "123e4567-e89b-12d3-a456-426614174000",
  "userId": "123e4567-e89b-12d3-a456-426614174000",
  "text": "text",
  "files": [
    {
      "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"
      }
    }
  ]
}

Remover anotação

delete
Autorizações
Parâmetros de rota
cardIdstring · uuidObrigatório

ID do card.

noteIdstring · uuidObrigatório

ID da anotação.

Respostas
200

Success

Sem conteúdo
delete
/v1/panel/card/{cardId}/note/{noteId}
DELETE /crm/v1/panel/card/{cardId}/note/{noteId} HTTP/1.1
Host: api.helena.run
Authorization: YOUR_API_KEY
Accept: */*

Sem conteúdo

Atualizado