Skip to main content
GET
/
conversation
Listar conversas
curl --request GET \
  --url http://localhost:3001/conversation/ \
  --header 'X-JuriChat-Api-Key: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "status": "ROBOT_INTERACTIVE",
      "priority": "LOW",
      "isFixed": true,
      "isGroup": true,
      "isPrivate": true,
      "isArchived": true,
      "responsables": [
        "<string>"
      ],
      "person": {
        "id": "<string>",
        "name": "<string>",
        "imageUrl": "<string>",
        "phoneNumber": "<string>"
      },
      "group": {
        "id": "<string>",
        "name": "<string>",
        "externalId": "<string>",
        "imageUrl": "<string>"
      },
      "user": {
        "id": "<string>",
        "name": "<string>",
        "imageUrl": "<string>"
      },
      "formattedDate": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "unreadCount": 123,
      "role": {
        "id": "<string>",
        "name": "<string>"
      },
      "tags": [
        {
          "id": "<string>",
          "name": "<string>",
          "color": "<string>"
        }
      ],
      "inbox": {
        "id": "<string>",
        "name": "<string>"
      },
      "integration": {
        "id": "<string>",
        "name": "<string>"
      },
      "lastMessage": {
        "id": "<string>",
        "content": "<string>",
        "type": "<string>",
        "messageAt": "<string>",
        "userId": "<string>",
        "userName": "<string>",
        "isViewedBySameUserLastMessage": true
      }
    }
  ],
  "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

page

Número da página.

limit

Quantidade de itens por página.

inboxId
string
required

ID da inbox. Obrigatório para filtrar as conversas.

content
string

Filtra por texto no conteúdo ou resumo da conversa.

tags
string

Filtra por tags (IDs separados por vírgula ou outro formato aceito).

integrationId

Filtra por canal de integração. Pode ser all, um ID ou uma lista de IDs.

Available options:
all
status
enum<string>

Filtra pelo status da conversa.

Available options:
ROBOT_INTERACTIVE,
INACTIVE,
HUMAN_INTERACTIVE,
WAITING_HUMAN
priority
enum<string>

Filtra pela prioridade da conversa.

Available options:
LOW,
MEDIUM,
HIGH
userId
string

Filtra pelo ID do usuário responsável.

Pattern: ^[cC][^\s-]{8,}$
roleId
string

Filtra pelo ID do papel responsável pela conversa.

showOnlyUnread
boolean

Quando verdadeiro, retorna apenas conversas com mensagens não lidas.

showGroups
boolean

Quando verdadeiro, inclui conversas de grupo.

onlyGroups
boolean

Quando verdadeiro, retorna apenas conversas de grupo.

onlyPrivate
boolean

Quando verdadeiro, retorna apenas conversas individuais (1:1).

onlyArchived
boolean

Quando verdadeiro, retorna apenas conversas arquivadas.

Response

Default Response

data
object[]
required
totalResults
number
required

Total de registros encontrados.

totalPages
number
required

Total de páginas para a quantidade solicitada.