Ver .md

scheduling.schedules_list

Listar agendas. Agendas da conta, da mais antiga à mais nova, com tudo que o formulário do original edita (ver scheduling.schedules_create) e attendantName, teamName, teamColor e publicPath (/book/{workspaceSlug}/{slug} quando pública). ownerType filtra por time (team) ou atendente (attendant); teamId e attendantId filtram por dono. Cada atendente ativo ganha uma agenda pessoal (isPersonal, com o nome do atendente) na primeira listagem. Sem a migration, a lista traz só as agendas pessoais de cada atendente ativo, montadas em memória (id pessoal:<atendente>, padrões da criação): a leitura funciona e qualquer escrita responde migration_pendente. Ids pessoal:<atendente> valem também em schedules_get, available_slots e nas notificações.

  • Endpoint: POST https://app.atomiks.com.br/api/v1/scheduling.schedules_list (corpo JSON)
  • Quem pode chamar: membro da conta
  • Escopo da chave: crm:read
  • Grava dados: não
  • Pela chave de API: sim
  • Ferramenta MCP: scheduling_schedules_list
  • Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId scheduling.schedules_list)

Entrada

CampoTipoObrigatórioNota
ownerType"team" | "attendant"não
teamIdstring (uuid)não
attendantIdstring (uuid)não
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "ownerType": {
      "type": "string",
      "enum": [
        "team",
        "attendant"
      ]
    },
    "teamId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "attendantId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    }
  }
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/scheduling.schedules_list \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"ownerType":"attendant"}'

CLI:

node cli/atomiks.mjs scheduling.schedules_list --json '{"ownerType":"attendant"}'

MCP: ferramenta scheduling_schedules_list com a mesma entrada.

Saída

Sucesso: {"data": ...} com o formato abaixo.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "items": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "slug": {
            "type": [
              "string",
              "null"
            ]
          },
          "description": {
            "type": [
              "string",
              "null"
            ]
          },
          "duration": {
            "type": "number"
          },
          "color": {
            "type": [
              "string",
              "null"
            ]
          },
          "isPublic": {
            "type": "boolean"
          },
          "isPersonal": {
            "type": "boolean"
          },
          "schedulingType": {
            "type": "string",
            "enum": [
              "individual",
              "group",
              "round_robin"
            ]
          },
          "attendantId": {
            "type": [
              "string",
              "null"
            ]
          },
          "memberId": {
            "type": [
              "string",
              "null"
            ]
          },
          "attendantName": {
            "type": [
              "string",
              "null"
            ]
          },
          "teamId": {
            "type": [
              "string",
              "null"
            ]
          },
          "teamName": {
            "type": [
              "string",
              "null"
            ]
          },
          "teamColor": {
            "type": [
              "string",
              "null"
            ]
          },
          "pipelineId": {
            "type": [
              "string",
              "null"
            ]
          },
          "stageId": {
            "type": [
              "string",
              "null"
            ]
          },
          "bufferMinutes": {
            "type": "number"
          },
          "minNoticeMinutes": {
            "type": "number"
          },
          "maxBookingsPerDay": {
            "type": [
              "number",
              "null"
            ]
          },
          "maxBookingsPerMemberPerDay": {
            "type": [
              "number",
              "null"
            ]
          },
          "maxAdvanceDays": {
            "type": [
              "number",
              "null"
            ]
          },
          "rollingWindowEnabled": {
            "type": "boolean"
          },
          "rollingWindowThresholdPercent": {
            "type": "number"
          },
          "rollingWindowStepDays": {
            "type": "number"
          },
          "confirmationMessage": {
            "type": [
              "string",
              "null"
            ]
          },
          "bookingFields": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "field": {
                  "type": "string"
                },
                "required": {
                  "type": "boolean"
                },
                "customFieldId": {
                  "type": "string"
                }
              },
              "required": [
                "field",
                "required"
              ],
              "additionalProperties": false
            }
          },
          "confirmationButtons": {
            "anyOf": [
              {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string"
                    },
                    "label": {
                      "type": "string"
                    },
                    "type": {
                      "type": "string"
                    },
                    "value": {
                      "type": "string"
                    },
                    "variant": {
                      "type": "string"
                    }
                  },
                  "required": [
                    "id",
                    "label",
                    "type",
                    "value",
                    "variant"
                  ],
                  "additionalProperties": false
                }
              },
              {
                "type": "null"
              }
            ]
          },
          "redirectUrl": {
            "type": [
              "string",
              "null"
            ]
          },
          "pixelId": {
            "type": [
              "string",
              "null"
            ]
          },
          "redirectDelaySeconds": {
            "type": [
              "number",
              "null"
            ]
          },
          "emailLayoutTemplateId": {
            "type": [
              "string",
              "null"
            ]
          },
          "otpVerificationEnabled": {
            "type": "boolean"
          },
          "otpChannel": {
            "type": "string",
            "enum": [
              "email",
              "whatsapp"
            ]
          },
          "otpEmailSenderSignatureId": {
            "type": [
              "string",
              "null"
            ]
          },
          "otpWhatsappTemplateId": {
            "type": [
              "string",
              "null"
            ]
          },
          "meetingLocationMode": {
            "type": "string",
            "enum": [
              "clickmax_meet",
              "google_meet",
              "attendant_room",
              "fixed_link"
            ]
          },
          "meetingLocationUrl": {
            "type": [
              "string",
              "null"
            ]
          },
          "meetPlaybookId": {
            "type": [
              "string",
              "null"
            ]
          },
          "meetCopilotAgentId": {
            "type": [
              "string",
              "null"
            ]
          },
          "memberCalendars": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "attendantId": {
                  "type": "string"
                },
                "externalCalendarIds": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                }
              },
              "required": [
                "attendantId",
                "externalCalendarIds"
              ],
              "additionalProperties": false
            }
          },
          "groupCapacity": {
            "type": "number"
          },
          "groupShowSeatsLeft": {
            "type": "boolean"
          },
          "sessionRules": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "dayOfWeek": {
                  "type": "integer",
                  "minimum": 0,
                  "maximum": 6
                },
                "startTime": {
                  "type": "string",
                  "pattern": "^([01][0-9]|2[0-3]):[0-5][0-9]$"
                }
              },
              "required": [
                "dayOfWeek",
                "startTime"
              ],
              "additionalProperties": false
            }
          },
          "publicPath": {
            "type": [
              "string",
              "null"
            ]
          },
          "createdAt": {
            "type": "string"
          },
          "updatedAt": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "name",
          "slug",
          "description",
          "duration",
          "color",
          "isPublic",
          "isPersonal",
          "schedulingType",
          "attendantId",
          "memberId",
          "attendantName",
          "teamId",
          "teamName",
          "teamColor",
          "pipelineId",
          "stageId",
          "bufferMinutes",
          "minNoticeMinutes",
          "maxBookingsPerDay",
          "maxBookingsPerMemberPerDay",
          "maxAdvanceDays",
          "rollingWindowEnabled",
          "rollingWindowThresholdPercent",
          "rollingWindowStepDays",
          "confirmationMessage",
          "bookingFields",
          "confirmationButtons",
          "redirectUrl",
          "pixelId",
          "redirectDelaySeconds",
          "emailLayoutTemplateId",
          "otpVerificationEnabled",
          "otpChannel",
          "otpEmailSenderSignatureId",
          "otpWhatsappTemplateId",
          "meetingLocationMode",
          "meetingLocationUrl",
          "meetPlaybookId",
          "meetCopilotAgentId",
          "memberCalendars",
          "groupCapacity",
          "groupShowSeatsLeft",
          "sessionRules",
          "publicPath",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "items"
  ],
  "additionalProperties": false
}

Erros

{"error": {"code", "message", "requestId"}}. Códigos: invalid_input (400), unauthorized (401), forbidden / account_pending / scope_missing (403), not_found (404), limit_reached (409), internal (500).