Skip to main content
GET
/
funnel-column-card
Listar cards de CRM
curl --request GET \
  --url http://localhost:3001/funnel-column-card/ \
  --header 'X-JuriChat-Api-Key: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "channel": "<string>",
      "columnId": "<string>",
      "user": {
        "id": "<string>",
        "name": "<string>",
        "imageUrl": "<string>",
        "role": "<string>",
        "email": "<string>",
        "document": "<string>"
      },
      "person": {
        "id": "<string>",
        "name": "<string>",
        "email": "<string>",
        "phone": "<string>",
        "imageUrl": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z"
      },
      "customFields": [
        {
          "id": "<string>",
          "name": "<string>",
          "type": "<string>",
          "options": "<unknown>",
          "value": "<unknown>"
        }
      ],
      "tags": [
        {
          "id": "<string>",
          "name": "<string>",
          "color": "<string>"
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "totalResults": 123,
  "totalPages": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.jurichat.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-JuriChat-Api-Key
string
header
required

Chave de API do escritório (criada no painel). Envie o valor no header X-JuriChat-Api-Key.

Query Parameters

​
columnId
string
required

ID da etapa do funil. Retorna os cards posicionados nessa etapa.

Pattern: ^[cC][^\s-]{8,}$
​
page
number

Número da página (começa em 1). Enviar junto com limit.

Required range: x >= 1
​
limit
number

Quantidade de cards por página. Máximo: 100.

Required range: 1 <= x <= 100
​
search
string

Filtra por nome ou e-mail do contato vinculado ao card.

Response

Default Response

​
data
object[]
required

Cards da página atual.

​
totalResults
number
required

Total de registros encontrados.

​
totalPages
number
required

Total de páginas para a quantidade solicitada.