Listar calendários

GET/calendars

Gerada do contrato OpenAPI

Lista os calendários da conta, com o ID, o nome e a duração de cada um. A API não lista os agendamentos: eles ficam na aba Agendamentos (Ver e cancelar agendamentos).

Requisição

curl "https://app.nextagsai.com.br/api/calendars" \
  -H "X-ACCESS-TOKEN: $NEXTAGS_API_KEY"

const resposta = await fetch('https://app.nextagsai.com.br/api/calendars', {
  headers: {
    'X-ACCESS-TOKEN': process.env.NEXTAGS_API_KEY,
  },
});
const dados = await resposta.json();
console.log(resposta.status, dados);

import os

import requests

resposta = requests.get(
    "https://app.nextagsai.com.br/api/calendars",
    headers={"X-ACCESS-TOKEN": os.environ["NEXTAGS_API_KEY"]},
    timeout=30,
)
print(resposta.status_code, resposta.json())

<?php
$ch = curl_init('https://app.nextagsai.com.br/api/calendars');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        'X-ACCESS-TOKEN: ' . getenv('NEXTAGS_API_KEY'),
    ],
]);
$dados = json_decode(curl_exec($ch), true);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), PHP_EOL;
print_r($dados);

Autenticação

Mande a chave de API da conta no cabeçalho X-ACCESS-TOKEN de cada chamada. Veja Autenticação com a chave de API.

Respostas

200Sucesso

Os calendários, em data.

dataarray de objeto Calendário

A lista de calendários (até 100).

data[].idinteger

O ID do calendário.

data[].namestring

O nome do calendário.

data[].durationinteger

A Duração do evento: quanto dura cada agendamento, em minutos (na tela, de 5 minutos a 23 horas).

data[].created_byinteger

O ID do administrador que criou.

data[].created_atstring (data e hora)

Quando o calendário foi criado, em UTC.

Exemplo: 2026-08-01 12:00:00

400Requisição inválida

Parâmetros inválidos.

401Chave inválida

A chave de API não veio no cabeçalho ou não vale (foi excluída ou está incompleta). Veja Autenticação.

Relacionados

Este conteúdo ajudou?

Obrigado! Sua resposta ajuda a melhorar a central.

const resposta = await fetch('https://app.nextagsai.com.br/api/calendars', { headers: { 'X-ACCESS-TOKEN': process.env.NEXTAGS_API_KEY, }, }); const dados = await resposta.json(); console.log(resposta.status, dados);

import os import requests resposta = requests.get( "https://app.nextagsai.com.br/api/calendars", headers={"X-ACCESS-TOKEN": os.environ["NEXTAGS_API_KEY"]}, timeout=30, ) print(resposta.status_code, resposta.json())

<?php $ch = curl_init('https://app.nextagsai.com.br/api/calendars'); curl_setopt_array($ch, [ CURLOPT_RETURNTRANSFER => true, CURLOPT_HTTPHEADER => [ 'X-ACCESS-TOKEN: ' . getenv('NEXTAGS_API_KEY'), ], ]); $dados = json_decode(curl_exec($ch), true); echo curl_getinfo($ch, CURLINFO_HTTP_CODE), PHP_EOL; print_r($dados);

{ "data": [ { "id": 8001, "name": "Avaliação gratuita", "duration": 30, "created_by": 10001, "created_at": "2026-08-01 12:00:00" }, { "id": 8002, "name": "Reunião de implantação", "duration": 60, "created_by": 10001, "created_at": "2026-08-12 15:30:00" } ] }

Autenticação

Respostas

Relacionados

Contatos, fluxos e outros identificadores

Limites, erros e boas práticas

Criar um calendário: disponibilidade, duração e limites

Agendar pela conversa: fluxo, IA ou Caixa de Entrada

Consultar calendário