Todos os planos Somente leitura

Suporte

Chamados de atendimento entre as famílias e a secretaria. Use para indicadores de atendimento (tempo de resposta, volume por assunto) ou para espelhar o histórico em um CRM de relacionamento.

O modelo chamado

id uuid

Identificador do chamado.

subject / description string

Assunto e descrição inicial.

status string

open ou closed.

opened_by object|null

Quem abriu o chamado.

messages_count / last_message_at integer / datetime

Mensagens trocadas e a data da última.

closed_at datetime|null

Quando foi encerrado.

O modelo chamado
{
  "id": "01a02631-8a84-72f2-a22e-9508352b23f7",
  "subject": "Segunda via do boleto",
  "description": "Não recebi o boleto deste mês.",
  "status": "open",
  "opened_by": {
    "id": "019e6e4b-6bb5-7023-91e2-782d91b20117",
    "name": "Mariana Costa"
  },
  "messages_count": 2,
  "last_message_at": "2026-10-01T18:20:37-03:00",
  "closed_at": null,
  "created_at": "2026-10-01T18:19:36-03:00"
}
GET /v1/partners/school/{cnpj}/support/tickets/all

Listar chamados

Chamados de atendimento abertos para a escola, do mais recente para o mais antigo. Paginado (25 por página).

Parâmetros de rota

cnpj string obrigatório

CNPJ da escola (14 dígitos, sem formatação).

Filtros (query string)

status string opcional

open ou closed.

search string opcional

Parte do assunto.

Códigos de resposta

200

Sucesso.

401

Credenciais inválidas (X-Partner, X-Client ou X-Authorization).

404

Escola ou recurso não encontrado.

422

Parâmetros inválidos — veja errors.

Requisição GET
GET /v1/partners/school/{cnpj}/support/tickets/all
curl https://toakiescola.com.br/api/v1/partners/school/{cnpj}/support/tickets/all \
  -H "X-Authorization: {api_token}" \
  -H "X-Partner: {partner_token}" \
  -H "X-Client: {client_slug}"
Resposta 
{
  "data": [
    {
      "id": "01a02631-8a84-72f2-a22e-9508352b23f7",
      "subject": "Segunda via do boleto",
      "description": "Não recebi o boleto deste mês.",
      "status": "open",
      "opened_by": {
        "id": "019e6e4b-6bb5-7023-91e2-782d91b20117",
        "name": "Mariana Costa"
      },
      "messages_count": 2,
      "last_message_at": "2026-10-01T18:20:37-03:00",
      "closed_at": null,
      "created_at": "2026-10-01T18:19:36-03:00"
    }
  ],
  "links": { /* first, prev, next */ },
  "meta": { "current_page": 1, "per_page": 25 }
}
GET /v1/partners/school/{cnpj}/support/ticket/{id}

Obter chamado

Um chamado com toda a conversa em ordem cronológica. from_school indica as mensagens enviadas pela equipe da escola.

Parâmetros de rota

cnpj string obrigatório

CNPJ da escola (14 dígitos, sem formatação).

id uuid obrigatório

UUID do chamado.

Códigos de resposta

200

Sucesso.

401

Credenciais inválidas (X-Partner, X-Client ou X-Authorization).

404

Escola ou recurso não encontrado.

Requisição GET
GET /v1/partners/school/{cnpj}/support/ticket/{id}
curl https://toakiescola.com.br/api/v1/partners/school/{cnpj}/support/ticket/{id} \
  -H "X-Authorization: {api_token}" \
  -H "X-Partner: {partner_token}" \
  -H "X-Client: {client_slug}"
Resposta 
{
  "data": {
    "id": "01a02631-8a84-72f2-a22e-9508352b23f7",
    "subject": "Segunda via do boleto",
    "description": "Não recebi o boleto deste mês.",
    "status": "open",
    "opened_by": {
      "id": "019e6e4b-6bb5-7023-91e2-782d91b20117",
      "name": "Mariana Costa"
    },
    "messages_count": 2,
    "last_message_at": "2026-10-01T18:20:37-03:00",
    "closed_at": null,
    "created_at": "2026-10-01T18:19:36-03:00",
    "messages": [
      {
        "id": "01a02631-0000-7000-8000-000000000a01",
        "author": {
          "id": "019e6e4b-6bb5-7023-91e2-782d91b20117",
          "name": "Mariana Costa"
        },
        "from_school": false,
        "message": "Não recebi o boleto deste mês.",
        "viewed": true,
        "created_at": "2026-10-01T18:19:36-03:00"
      },
      {
        "id": "01a02631-0000-7000-8000-000000000a02",
        "author": {
          "id": "019e6e4b-7000-7000-8000-000000000a03",
          "name": "Joana Secretaria"
        },
        "from_school": true,
        "message": "Olá! Reenviamos o boleto para o seu e-mail.",
        "viewed": false,
        "created_at": "2026-10-01T18:20:37-03:00"
      }
    ]
  }
}