Consultar calendário

GET/calendars/{calendar_id}

Gerada do contrato OpenAPI

Devolve um calendário pelo ID: o nome, a duração de cada agendamento, quem criou e quando. Para usar o calendário numa conversa, veja Agendar pela conversa.

Requisição

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

const resposta = await fetch('https://app.nextagsai.com.br/api/calendars/8001', {
  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/8001",
    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/8001');
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.

Parâmetros de caminho

calendar_idintegerobrigatório

O ID do calendário (veja Listar calendários).

Respostas

200Sucesso

O calendário.

idinteger

O ID do calendário.

namestring

O nome do calendário.

durationinteger

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

created_byinteger

O ID do administrador que criou.

created_atstring (data e hora)

Quando o calendário foi criado, em UTC.

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

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

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

Tutorial da Central de Ajuda

Listar calendários

GET /calendars

Este conteúdo ajudou?

Obrigado! Sua resposta ajuda a melhorar a central.

const resposta = await fetch('https://app.nextagsai.com.br/api/calendars/8001', { 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/8001", 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/8001'); 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);