proposals.templates_list

Listar modelos de proposta. Modelos de proposta da conta, do mais recente ao mais antigo. Filtros: search (nome), kind, status; library: true traz só os que podem gerar proposta (ativos, slide deck ou documento). stats conta tudo da conta (total, ativos, rascunhos e slide decks), sem os filtros. Sem a migration do banco devolve a lista vazia.

• Endpoint: POST https://app.atomiks.com.br/api/v1/proposals.templates_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: proposals_templates_list
• Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId proposals.templates_list)

Entrada

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "page": {
      "default": 1,
      "type": "integer",
      "minimum": 1,
      "maximum": 9007199254740991
    },
    "perPage": {
      "default": 20,
      "type": "integer",
      "minimum": 1,
      "maximum": 2000
    },
    "search": {
      "type": "string",
      "maxLength": 100
    },
    "kind": {
      "type": "string",
      "enum": [
        "slide_deck",
        "document",
        "pdf"
      ]
    },
    "status": {
      "type": "string",
      "enum": [
        "draft",
        "active",
        "archived"
      ]
    },
    "library": {
      "type": "boolean"
    }
  }
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/proposals.templates_list \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"page":1,"perPage":20,"library":true}'

CLI:

node cli/atomiks.mjs proposals.templates_list --json '{"page":1,"perPage":20,"library":true}'

MCP: ferramenta proposals_templates_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"
          },
          "description": {
            "type": [
              "string",
              "null"
            ]
          },
          "kind": {
            "type": "string",
            "enum": [
              "slide_deck",
              "document",
              "pdf"
            ]
          },
          "status": {
            "type": "string",
            "enum": [
              "draft",
              "active",
              "archived"
            ]
          },
          "coverHtml": {
            "type": [
              "string",
              "null"
            ]
          },
          "createdAt": {
            "type": "string"
          },
          "updatedAt": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "name",
          "description",
          "kind",
          "status",
          "coverHtml",
          "createdAt",
          "updatedAt"
        ],
        "additionalProperties": false
      }
    },
    "total": {
      "type": "number"
    },
    "pages": {
      "type": "number"
    },
    "stats": {
      "type": "object",
      "properties": {
        "total": {
          "type": "number"
        },
        "active": {
          "type": "number"
        },
        "drafts": {
          "type": "number"
        },
        "slideDeck": {
          "type": "number"
        }
      },
      "required": [
        "total",
        "active",
        "drafts",
        "slideDeck"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "items",
    "total",
    "pages",
    "stats"
  ],
  "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).