crm.products_list

Listar produtos. Produtos da conta por ordem de nome. q filtra pelo nome; arquivados só com includeArchived. Preço em centavos (BRL).

• Endpoint: POST https://app.atomiks.com.br/api/v1/crm.products_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: crm_products_list
• Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId crm.products_list)

Entrada

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "q": {
      "type": "string",
      "maxLength": 100
    },
    "includeArchived": {
      "type": "boolean"
    }
  }
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/crm.products_list \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"q":"mentoria"}'

CLI:

node cli/atomiks.mjs crm.products_list --json '{"q":"mentoria"}'

MCP: ferramenta crm_products_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"
          },
          "kind": {
            "type": "string",
            "enum": [
              "physical",
              "digital",
              "service"
            ]
          },
          "name": {
            "type": "string"
          },
          "description": {
            "type": [
              "string",
              "null"
            ]
          },
          "priceCents": {
            "type": "integer",
            "minimum": -9007199254740991,
            "maximum": 9007199254740991
          },
          "imageUrl": {
            "type": [
              "string",
              "null"
            ]
          },
          "archived": {
            "type": "boolean"
          }
        },
        "required": [
          "id",
          "kind",
          "name",
          "description",
          "priceCents",
          "imageUrl",
          "archived"
        ],
        "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).