---
agentTools:
  projectIndex: https://productplan.readme.io/llms.txt
---

# GET Idea Forms

Returns a list of all Idea Forms by user.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "ProductPlan API V2",
    "version": "v2"
  },
  "paths": {
    "/api/v2/discovery/idea_forms": {
      "get": {
        "summary": "GET Idea Forms",
        "parameters": [
          {
            "name": "page",
            "in": "query",
            "schema": {
              "type": "integer",
              "description": "Indicates which page number to retrieve (based on a given page size)",
              "default": 1
            }
          },
          {
            "name": "page_size",
            "in": "query",
            "schema": {
              "type": "integer",
              "description": "The amount of items to return with each page (default: 200, max: 500)",
              "default": 200
            }
          },
          {
            "name": "q",
            "in": "query",
            "schema": {
              "type": "object",
              "description": "Filter and sort query. (Filterable attributes: `account_id,created_at,id,instructions,is_enabled,title,updated_at,url_token,user_id,custom_text_field,custom_dropdown_fields`). Visit our [filtering docs](/reference/filtering) for more information about how filtering works.",
              "example": {
                "title_eq": "title filter"
              },
              "default": {
                "created_at_lt": "2024-01-01"
              }
            },
            "style": "deepObject",
            "explode": true
          }
        ],
        "tags": [
          "Idea Forms"
        ],
        "description": "Returns a list of all Idea Forms by user.",
        "security": [
          {
            "bearer": []
          }
        ],
        "responses": {
          "200": {
            "description": "lists idea forms",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "results": {
                      "type": "array",
                      "items": {
                        "$ref": "#/components/schemas/IdeaFormIndex"
                      },
                      "required": [
                        "items"
                      ]
                    },
                    "paging": {
                      "$ref": "#/components/schemas/Pagination"
                    }
                  },
                  "required": [
                    "results",
                    "paging"
                  ]
                }
              }
            }
          },
          "401": {
            "description": "authentication failed",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          },
          "422": {
            "description": "bad pagination parameters",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Error"
                }
              }
            }
          }
        }
      }
    }
  },
  "tags": [
    {
      "name": "Idea Forms"
    }
  ],
  "servers": [
    {
      "url": "https://{defaultHost}",
      "variables": {
        "defaultHost": {
          "default": "app.productplan.com"
        }
      }
    }
  ],
  "components": {
    "schemas": {
      "IdeaCustomFieldValue": {
        "type": "object",
        "properties": {
          "label": {
            "type": "string",
            "description": "The field's label",
            "example": "Ship name"
          }
        },
        "required": [
          "label"
        ],
        "additionalProperties": false
      },
      "IdeaCustomLabelGroup": {
        "type": "object",
        "properties": {
          "label": {
            "type": "string",
            "description": "The field's label",
            "example": "Ship name"
          },
          "allowed_values": {
            "type": "array",
            "description": "The allowed values for the field",
            "example": [
              "Sea Monkey",
              "Sea Cucumber"
            ]
          }
        },
        "required": [
          "label",
          "allowed_values"
        ],
        "additionalProperties": false
      },
      "IdeaFormIndex": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The Idea Form's unique database identifier.",
            "example": 1
          },
          "title": {
            "type": "string",
            "description": "Title of the Idea Form.",
            "example": "Feedback of new admin process"
          },
          "instructions": {
            "type": "string",
            "description": "Instructions of the Idea Form.",
            "example": "Please fill with your feedback"
          },
          "is_enabled": {
            "type": "boolean",
            "description": "Defines availability of the Idea Form to incoming new ideas",
            "example": true,
            "default": true
          },
          "created_at": {
            "type": "string",
            "format": "date-time",
            "description": "Date and time the Idea Form was first created."
          },
          "updated_at": {
            "type": "string",
            "format": "date-time",
            "description": "Date and time the Idea Form was last updated."
          },
          "custom_text_fields": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/IdeaCustomFieldValue"
            }
          },
          "custom_dropdown_fields": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/IdeaCustomLabelGroup"
            }
          }
        },
        "additionalProperties": false
      },
      "Error": {
        "type": "object",
        "properties": {
          "errors": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        },
        "required": [
          "errors"
        ],
        "additionalProperties": false
      },
      "Pagination": {
        "type": "object",
        "properties": {
          "record_count": {
            "type": "integer",
            "description": "The total number of elements existing in the collection (pre-paging)"
          },
          "page_count": {
            "type": "integer",
            "description": "The total number of pages"
          },
          "current_page": {
            "type": "integer",
            "description": "The current page"
          },
          "page_size": {
            "type": "integer",
            "description": "The number of elements returned in the current page"
          }
        },
        "required": [
          "record_count",
          "page_count",
          "current_page",
          "page_size"
        ],
        "additionalProperties": false
      }
    },
    "securitySchemes": {
      "bearer": {
        "type": "http",
        "scheme": "bearer"
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 100,
      "1": 145,
      "2": 51,
      "3": 180,
      "4": 236,
      "5": 85,
      "6": 77,
      "7": 0,
      "8": 85,
      "9": 123,
      "10": 158,
      "11": 250
    }
  }
}
```