Ir para o conteúdo
Pipefácil

Listar intervalo do calendário

Ver como MarkdownConfigurar agente
GET/api/v1/calendar/events

Retorna itens das fontes solicitadas no intervalo, ordenados pelo início, e o status de cada fonte. Fontes indisponíveis são indicadas em sources[] (not_connected, not_authorized, error, truncated), sem falhar toda a requisição.

Visibilidade. A chave representa o membro que a criou. Quem só vê seus próprios dados recebe sua própria agenda; memberId é ignorado. Quem vê todos os dados pode consultar outro membro, exceto um administrador ou o proprietário do workspace. Solicitar explicitamente a agenda desses membros resulta em 403; sem memberId, seus itens são omitidos. O proprietário pode acessar todas as agendas. Reuniões às quais o membro foi convidado são retornadas, independentemente do proprietário da reunião.

Limitação. O limite de itens por fonte e o status de sources[] são calculados antes do filtro de visibilidade. Assim, eventos invisíveis podem contribuir para um erro de limite (422), e uma fonte inteiramente filtrada pode retornar ok e uma lista vazia.

Google Calendar. A conexão é pessoal. Consultar a agenda de outro membro retorna apenas seus itens nativos, sem os eventos da conexão Google desse membro.

Exemplos

A URL usa o servidor de produção. Defina PIPEFACIL_API_KEY e as variáveis de caminho (como SEQ ou ID) com os identificadores reais. Ajuste o corpo antes de executar: requisições de escrita alteram dados do workspace.

cURL

curl --request GET \
  --url "https://pipefacil-server.matchsales.com.br/api/v1/calendar/events?timeMin=2026-10-06T00%3A00%3A00Z&timeMax=2026-10-07T00%3A00%3A00Z" \
  --header "Authorization: Bearer $PIPEFACIL_API_KEY"
JavaScript
const response = await fetch(`https://pipefacil-server.matchsales.com.br/api/v1/calendar/events?timeMin=2026-10-06T00%3A00%3A00Z&timeMax=2026-10-07T00%3A00%3A00Z`, {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.PIPEFACIL_API_KEY}`,
  },
});

if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const text = await response.text();
const data = text ? JSON.parse(text) : null;
Python
import os
import json
import requests

response = requests.request(
    "GET",
    f"https://pipefacil-server.matchsales.com.br/api/v1/calendar/events?timeMin=2026-10-06T00%3A00%3A00Z&timeMax=2026-10-07T00%3A00%3A00Z",
    headers={"Authorization": f"Bearer {os.environ['PIPEFACIL_API_KEY']}"},
)
response.raise_for_status()
data = response.json() if response.content else None

Parâmetros

NomeLocalTipoObrigatórioDescrição
timeMinquerystringSimInício da janela de consulta, em ISO 8601 e UTC.
timeMaxquerystringSimFim do intervalo em ISO 8601 UTC. Aceita até 400 dias após timeMin; acima disso, responde 400.
memberIdquerystringNãoAgenda de outro membro, pelo identificador de membro do workspace.
providerqueryarray de stringNãoFiltro de fontes; pode ser repetido.
kindqueryarray de stringNãoFiltro de tipos de item; pode ser repetido.

Respostas

200Sucesso
CampoTipoDescrição
dataobject—
data.itemsarray—
data.items[].idstringprovider:kind:id, por exemplo, native:meeting:5f2c…
data.items[].providerstringValores: native, google.
data.items[].kindstringValores: meeting, task, cadence_task.
data.items[].readOnlybooleanNão pode ser alterado por esta API; somente reuniões nativas permitem escrita.
data.items[].statusstringconfirmed, tentative, cancelled.
data.items[].summarystring—
data.items[].descriptionstringAceita null.
data.items[].locationstringAceita null.
data.items[].startEventDateTimeMesmo formato do Google Calendar: date para dia inteiro ou dateTime para instante ISO 8601. Nunca envie ambos.
data.items[].start.datestringData no formato YYYY-MM-DD para eventos de dia inteiro. Formato: date. Aceita null.
data.items[].start.dateTimestringFormato: date-time. Aceita null.
data.items[].start.timeZonestringFuso IANA. Padrão: fuso do workspace. Aceita null.
data.items[].endEventDateTimeMesmo formato do Google Calendar: date para dia inteiro ou dateTime para instante ISO 8601. Nunca envie ambos.
data.items[].end.datestringData no formato YYYY-MM-DD para eventos de dia inteiro. Formato: date. Aceita null.
data.items[].end.dateTimestringFormato: date-time. Aceita null.
data.items[].end.timeZonestringFuso IANA. Padrão: fuso do workspace. Aceita null.
data.items[].attendeesarray—
data.items[].attendees[].typestringValores: member, contact.
data.items[].attendees[].memberobjectAceita null.
data.items[].attendees[].member.idstring—
data.items[].attendees[].member.userIdstring—
data.items[].attendees[].member.namestring—
data.items[].attendees[].member.emailstring—
data.items[].attendees[].member.imagestringAceita null.
data.items[].attendees[].member.rolestring—
data.items[].attendees[].contactobjectAceita null.
data.items[].attendees[].contact.idstring—
data.items[].attendees[].contact.displayNamestring—
data.items[].attendees[].contact.emailstringAceita null.
data.items[].attendees[].contact.phonestringAceita null.
data.items[].attendees[].removedbooleanA identidade não existe mais; o convidado continua no histórico.
data.items[].attendees[].responseStatusstringValores: needs_action, accepted, declined, tentative.
data.items[].attendees[].organizerboolean—
data.items[].attendees[].optionalboolean—
data.items[].ownerobjectNulo quando o membro proprietário saiu do workspace. Aceita null.
data.items[].owner.userIdstring—
data.items[].owner.namestring—
data.items[].owner.emailstring—
data.items[].owner.imagestringAceita null.
data.items[].owner.rolestringPapel do membro no workspace, por exemplo owner.
data.items[].owner.idstringID do vínculo de membro no workspace. userId identifica o usuário.
data.items[].extendedPropertiesobjectAceita null.
data.items[].conferenceUrlstringLink da reunião, independentemente de sua origem. Aceita null.
data.items[].botEnabledbooleanO bot de gravação está configurado para esta reunião.
data.items[].botStatusstringÚltimo estado informado pelo bot. Aceita null.
data.items[].createdstringFormato: date-time. Aceita null.
data.items[].updatedstringFormato: date-time. Aceita null.
data.sourcesarray—
data.sources[].providerstringValores: native, google.
data.sources[].kindstringValores: meeting, task, cadence_task.
data.sources[].statusstringValores: ok, not_connected, not_authorized, truncated, error.
data.sources[].messagestringAceita null.
messagestringAceita null.
Esquema OpenAPI
{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "items": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/CalendarEvent"
          }
        },
        "sources": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/CalendarSourceStatus"
          }
        }
      }
    },
    "message": {
      "type": "string",
      "nullable": true
    }
  }
}
400Falha de validação dos campos; `fieldErrors` contém os erros.
CampoTipoDescrição
errorstring—
codestringValores: BAD_REQUEST, VALIDATION_ERROR, UNAUTHORIZED, FORBIDDEN, FEATURE_DISABLED, NOT_FOUND, CONFLICT, QUOTA_EXCEEDED, UNPROCESSABLE_ENTITY, INTERNAL_ERROR, SERVICE_UNAVAILABLE.
requestIdstring—
detailsstringAceita null.
fieldErrorsarrayAceita null.
fieldErrors[].fieldstring—
fieldErrors[].messagestring—
Esquema OpenAPI
{
  "type": "object",
  "description": "Formato padrão de erro. `details` e `fieldErrors` são omitidos quando ausentes.",
  "properties": {
    "error": {
      "type": "string"
    },
    "code": {
      "type": "string",
      "enum": [
        "BAD_REQUEST",
        "VALIDATION_ERROR",
        "UNAUTHORIZED",
        "FORBIDDEN",
        "FEATURE_DISABLED",
        "NOT_FOUND",
        "CONFLICT",
        "QUOTA_EXCEEDED",
        "UNPROCESSABLE_ENTITY",
        "INTERNAL_ERROR",
        "SERVICE_UNAVAILABLE"
      ]
    },
    "requestId": {
      "type": "string"
    },
    "details": {
      "type": "string",
      "nullable": true
    },
    "fieldErrors": {
      "type": "array",
      "nullable": true,
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      }
    }
  },
  "required": [
    "error",
    "code",
    "requestId"
  ]
}
401Chave ausente, malformada, desconhecida, revogada ou expirada, ou membro emissor inativo.
CampoTipoDescrição
errorstring—
codestringValores: BAD_REQUEST, VALIDATION_ERROR, UNAUTHORIZED, FORBIDDEN, FEATURE_DISABLED, NOT_FOUND, CONFLICT, QUOTA_EXCEEDED, UNPROCESSABLE_ENTITY, INTERNAL_ERROR, SERVICE_UNAVAILABLE.
requestIdstring—
detailsstringAceita null.
fieldErrorsarrayAceita null.
fieldErrors[].fieldstring—
fieldErrors[].messagestring—
Esquema OpenAPI
{
  "type": "object",
  "description": "Formato padrão de erro. `details` e `fieldErrors` são omitidos quando ausentes.",
  "properties": {
    "error": {
      "type": "string"
    },
    "code": {
      "type": "string",
      "enum": [
        "BAD_REQUEST",
        "VALIDATION_ERROR",
        "UNAUTHORIZED",
        "FORBIDDEN",
        "FEATURE_DISABLED",
        "NOT_FOUND",
        "CONFLICT",
        "QUOTA_EXCEEDED",
        "UNPROCESSABLE_ENTITY",
        "INTERNAL_ERROR",
        "SERVICE_UNAVAILABLE"
      ]
    },
    "requestId": {
      "type": "string"
    },
    "details": {
      "type": "string",
      "nullable": true
    },
    "fieldErrors": {
      "type": "array",
      "nullable": true,
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      }
    }
  },
  "required": [
    "error",
    "code",
    "requestId"
  ]
}
403Autenticado, mas sem acesso: falta de permissão (`FORBIDDEN`), recurso desligado no workspace (`FEATURE_DISABLED`) ou tentativa de acessar uma agenda não permitida.
CampoTipoDescrição
errorstring—
codestringValores: BAD_REQUEST, VALIDATION_ERROR, UNAUTHORIZED, FORBIDDEN, FEATURE_DISABLED, NOT_FOUND, CONFLICT, QUOTA_EXCEEDED, UNPROCESSABLE_ENTITY, INTERNAL_ERROR, SERVICE_UNAVAILABLE.
requestIdstring—
detailsstringAceita null.
fieldErrorsarrayAceita null.
fieldErrors[].fieldstring—
fieldErrors[].messagestring—
Esquema OpenAPI
{
  "type": "object",
  "description": "Formato padrão de erro. `details` e `fieldErrors` são omitidos quando ausentes.",
  "properties": {
    "error": {
      "type": "string"
    },
    "code": {
      "type": "string",
      "enum": [
        "BAD_REQUEST",
        "VALIDATION_ERROR",
        "UNAUTHORIZED",
        "FORBIDDEN",
        "FEATURE_DISABLED",
        "NOT_FOUND",
        "CONFLICT",
        "QUOTA_EXCEEDED",
        "UNPROCESSABLE_ENTITY",
        "INTERNAL_ERROR",
        "SERVICE_UNAVAILABLE"
      ]
    },
    "requestId": {
      "type": "string"
    },
    "details": {
      "type": "string",
      "nullable": true
    },
    "fieldErrors": {
      "type": "array",
      "nullable": true,
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      }
    }
  },
  "required": [
    "error",
    "code",
    "requestId"
  ]
}
404Recurso não encontrado ou fora da visibilidade do membro.
CampoTipoDescrição
errorstring—
codestringValores: BAD_REQUEST, VALIDATION_ERROR, UNAUTHORIZED, FORBIDDEN, FEATURE_DISABLED, NOT_FOUND, CONFLICT, QUOTA_EXCEEDED, UNPROCESSABLE_ENTITY, INTERNAL_ERROR, SERVICE_UNAVAILABLE.
requestIdstring—
detailsstringAceita null.
fieldErrorsarrayAceita null.
fieldErrors[].fieldstring—
fieldErrors[].messagestring—
Esquema OpenAPI
{
  "type": "object",
  "description": "Formato padrão de erro. `details` e `fieldErrors` são omitidos quando ausentes.",
  "properties": {
    "error": {
      "type": "string"
    },
    "code": {
      "type": "string",
      "enum": [
        "BAD_REQUEST",
        "VALIDATION_ERROR",
        "UNAUTHORIZED",
        "FORBIDDEN",
        "FEATURE_DISABLED",
        "NOT_FOUND",
        "CONFLICT",
        "QUOTA_EXCEEDED",
        "UNPROCESSABLE_ENTITY",
        "INTERNAL_ERROR",
        "SERVICE_UNAVAILABLE"
      ]
    },
    "requestId": {
      "type": "string"
    },
    "details": {
      "type": "string",
      "nullable": true
    },
    "fieldErrors": {
      "type": "array",
      "nullable": true,
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      }
    }
  },
  "required": [
    "error",
    "code",
    "requestId"
  ]
}
429Limite de requisições excedido por workspace ou IP.
CampoTipoDescrição
errorstring—
codestringValores: BAD_REQUEST, VALIDATION_ERROR, UNAUTHORIZED, FORBIDDEN, FEATURE_DISABLED, NOT_FOUND, CONFLICT, QUOTA_EXCEEDED, UNPROCESSABLE_ENTITY, INTERNAL_ERROR, SERVICE_UNAVAILABLE.
requestIdstring—
detailsstringAceita null.
fieldErrorsarrayAceita null.
fieldErrors[].fieldstring—
fieldErrors[].messagestring—
Esquema OpenAPI
{
  "type": "object",
  "description": "Formato padrão de erro. `details` e `fieldErrors` são omitidos quando ausentes.",
  "properties": {
    "error": {
      "type": "string"
    },
    "code": {
      "type": "string",
      "enum": [
        "BAD_REQUEST",
        "VALIDATION_ERROR",
        "UNAUTHORIZED",
        "FORBIDDEN",
        "FEATURE_DISABLED",
        "NOT_FOUND",
        "CONFLICT",
        "QUOTA_EXCEEDED",
        "UNPROCESSABLE_ENTITY",
        "INTERNAL_ERROR",
        "SERVICE_UNAVAILABLE"
      ]
    },
    "requestId": {
      "type": "string"
    },
    "details": {
      "type": "string",
      "nullable": true
    },
    "fieldErrors": {
      "type": "array",
      "nullable": true,
      "items": {
        "type": "object",
        "properties": {
          "field": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      }
    }
  },
  "required": [
    "error",
    "code",
    "requestId"
  ]
}
OpenAPI JSONMarkdown desta operação

Precisa de ajuda?

Encontrou um problema ou ficou com uma dúvida? Fale com a equipe pelo WhatsApp.

Chamar no WhatsApp
Pipefácil