---
agentTools:
  projectIndex: https://developers.pipe.run/llms.txt
---

# Listar formulários customizados

*Endpoint* utilizado para **listar todos os formulários customizados** cadastrados na conta do CRM PipeRun.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "application/json",
    "version": "1.1-CRM"
  },
  "servers": [
    {
      "url": "https://api.pipe.run/v1"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "apiKey",
        "name": "token",
        "in": "header"
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/customForms": {
      "get": {
        "summary": "Listar formulários customizados",
        "description": "",
        "operationId": "listar-formulários-customizados",
        "parameters": [
          {
            "name": "show",
            "in": "query",
            "description": "Número de itens na página de resultado.",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "cursor",
            "in": "query",
            "description": "Hash da próxima página.",
            "schema": {
              "type": "string",
              "default": "\"\""
            }
          },
          {
            "name": "sort",
            "in": "query",
            "description": "Critérios de ordenação (ASC / DESC).",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "name",
            "in": "query",
            "description": "Filtrar pelo nome do formulário customizado.",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "created_at_start",
            "in": "query",
            "description": "Filtrar por registros de formulários customizados a partir da data e hora de criação  informada.",
            "schema": {
              "type": "string",
              "format": "date-time",
              "default": "2025-10-02 00:00:00"
            }
          },
          {
            "name": "created_at_end",
            "in": "query",
            "description": "Filtrar por registros de formulários customizados até a data e hora de criação  informada.",
            "schema": {
              "type": "string",
              "format": "date-time",
              "default": "2025-01-01 00:00:00"
            }
          },
          {
            "name": "updated_at_start",
            "in": "query",
            "description": "Filtrar por registros de formulários customizados a partir da data e hora de atualização  informada.",
            "schema": {
              "type": "string",
              "format": "date-time",
              "default": "2025-10-01 00:00:00"
            }
          },
          {
            "name": "updated_at_end",
            "in": "query",
            "description": "Filtrar por registros de formulários customizados até a data e hora de atualização  informada.",
            "schema": {
              "type": "string",
              "format": "date-time",
              "default": "2025-10-02 00:00:00"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"success\": true,\n  \"message\": \"OK\",\n  \"data\": [\n    {\n      \"id\": 123,\n      \"account_id\": 123,\n      \"name\": \"teste jess\",\n      \"type\": 1,\n      \"status\": true,\n      \"page_title\": \"Título exemplo\",\n      \"page_content\": \"<p>\\n  mhjvbkln;';lbkvhjvbknl;m\\n</p>\",\n      \"page_background_color\": \"#FFFFFF\",\n      \"page_text_color\": \"#000000\",\n      \"page_logo_url\": null,\n      \"form_background_color\": \"#E7E7E7\",\n      \"form_text_color\": \"#000000\",\n      \"form_button_background_color\": \"#ed5565\",\n      \"form_button_text_color\": \"#FFFFFF\",\n      \"form_with_rounded_borders\": 1,\n      \"form_show_icons\": true,\n      \"created_at\": \"2025-06-23 13:37:44\",\n      \"updated_at\": \"2025-06-23 13:37:44\"\n      \"fields\": [\n        {\n          \"id\": 123,\n          \"account_id\": 123,\n          \"custom_form_id\": 123,\n          \"custom_field_id\": null,\n          \"native_field_name\": \"name\",\n          \"native_field_type\": 100,\n          \"native_field_entity\": 2,\n          \"required\": false,\n          \"order\": 1,\n          \"created_at\": \"2025-06-23 13:37:44\",\n          \"updated_at\": \"2025-06-23 13:37:44\"\n        }\n      ]\n}\n],\n  \"meta\": {\n    \"cursor\": {\n      \"current\": null,\n      \"prev\": null,\n      \"next\": \"eyJpZCI6Mzc4OD...I6dHJ1ZX0\",\n      \"count\": null\n    }\n  }\n}"
                  }
                }
              }
            }
          },
          "404": {
            "description": "404",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n  \"success\": false,\n  \"message\": \"Not Found\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean",
                      "example": false,
                      "default": true
                    },
                    "message": {
                      "type": "string",
                      "example": "Not Found"
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true,
  "_id": "686d5ab389846000619e863f:686d5ab389846000619e866c"
}
```