Skip to main content
GET
/
crm
/
assuntos
Listar assuntos
curl --request GET \
  --url https://api.tiny.com.br/public-api/v3/crm/assuntos \
  --header 'Authorization: Bearer <token>'
{
  "itens": [
    {
      "id": 123,
      "assunto": "<string>",
      "cliente": {
        "id": 123,
        "nome": "<string>",
        "codigo": "<string>",
        "fantasia": "<string>",
        "tipoPessoa": "J",
        "cpfCnpj": "<string>",
        "inscricaoEstadual": "<string>",
        "rg": "<string>",
        "telefone": "<string>",
        "celular": "<string>",
        "email": "<string>",
        "pessoaContato": {
          "nome": "<string>",
          "telefone": "<string>",
          "email": "<string>",
          "ramal": "<string>",
          "departamento": "<string>"
        },
        "endereco": {
          "endereco": "<string>",
          "numero": "<string>",
          "complemento": "<string>",
          "bairro": "<string>",
          "municipio": "<string>",
          "cep": "<string>",
          "uf": "<string>",
          "pais": "<string>"
        },
        "statusCrm": "L"
      },
      "estagio": {
        "id": 123,
        "descricao": "<string>"
      },
      "estrela": true,
      "arquivado": true,
      "data": "2024-01-01",
      "dataAtualizacao": "2024-01-01 00:00:00",
      "totalAcoes": 123,
      "totalAnotacoes": 123,
      "proximaAcao": {
        "descricao": "<string>",
        "tipo": "D",
        "data": "2024-01-01"
      }
    }
  ],
  "paginacao": {
    "limit": 123,
    "offset": 123,
    "total": 123
  }
}

Query Parameters

situacao
enum<string>

Filtra pelo status das ações do assunto

  • pendente - Com ações pendentes
  • encerrado - Sem ações pendentes/todas concluídas
Available options:
pendente,
encerrado
estrela
boolean

Filtra apenas assuntos marcados com estrela

arquivado
boolean

Filtra apenas assuntos arquivados

idContato
integer

Filtra pelo ID do contato vinculado ao assunto

idPessoaContato
integer

Filtra pelo ID da pessoa de contato vinculada ao assunto

nomeCliente
string

Pesquisa por nome do cliente vinculado ao assunto

statusCrm
enum<string>

Filtra pelo status CRM do contato vinculado ao assunto

  • L - Lead
  • P - Prospect
  • C - Cliente
  • I - Inativo
Available options:
L,
P,
C,
I
idEstagio
integer

Filtra pelo id do estágio no funil de vendas

assunto
string

Busca por texto na descrição do assunto parcial ou completo

filtrarPor
enum<string>
default:data-criacao

Define o critério de filtro

  • data-criacao - Data de criação do assunto
  • data-prevista - Ações com data prevista (tipo D)
  • quanto-antes - Ações quanto antes (tipo Q)
  • esperar - Ações para esperar (tipo E)
Available options:
data-criacao,
data-prevista,
quanto-antes,
esperar
dataInicial
string

Data inicial para filtro (aplica-se ao critério escolhido em 'filtrarPor')

Example:

"2024-01-01"

dataFinal
string

Data final para filtro (aplica-se ao critério escolhido em 'filtrarPor')

Example:

"2024-12-31"

marcadores

Pesquisa por marcadores

descricaoAcao
string

Busca por texto na descrição da ação do assunto parcial ou completo

idUsuario
integer

Filtra pelo id do usuário que criou as ações do assunto

idUsuarioResponsavel
integer

Filtra pelo id do usuário responsável pelas ações do assunto

limit
integer
default:100

Limite da paginação

offset
integer
default:0

Offset da paginação

Response

OK

itens
· object[]
paginacao
· object