---
updatedAt: 2026-06-26T23:36:44.000Z
agentTools:
  projectIndex: https://docs.smartsurvey.io/llms.txt
---

# Get All

Get all filter groups for the specified survey. Temporary filter groups are included and marked with is_temporary. Hidden filter groups (private copies saved with a results view) are left out, and are not counted in the paging totals.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "SS Public API",
    "version": "v2"
  },
  "servers": [
    {
      "url": "https://{host}/v2",
      "description": "Select the host for the region your account's data is stored in.",
      "variables": {
        "host": {
          "default": "api.smartsurvey.io",
          "description": "The regional hostname for your account.",
          "enum": [
            "api.smartsurvey.io",
            "api-eu.smartsurvey.io",
            "api-us.smartsurvey.io"
          ]
        }
      }
    }
  ],
  "paths": {
    "/surveys/{surveyId}/filter-groups": {
      "get": {
        "tags": [
          "FilterGroups"
        ],
        "summary": "Get All",
        "description": "Get all filter groups for the specified survey. Temporary filter groups are included and marked with is_temporary. Hidden filter groups (private copies saved with a results view) are left out, and are not counted in the paging totals.",
        "parameters": [
          {
            "name": "surveyId",
            "in": "path",
            "description": "The survey id whose Filter Groups you are querying",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "page",
            "in": "query",
            "description": "The 1-based page number",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "page_size",
            "in": "query",
            "description": "The number of results you want up to 100",
            "schema": {
              "type": "integer",
              "format": "int32"
            }
          },
          {
            "name": "sort_by",
            "in": "query",
            "description": "Optional list of properties that you want to sort by",
            "schema": {
              "type": "array",
              "items": {
                "type": "string"
              }
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/SmartSurvey.Public.API.Helpers.PaginatedListFilterGroupResponse"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SmartSurvey.Public.API.Helpers.PaginatedListFilterGroupResponse"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/SmartSurvey.Public.API.Helpers.PaginatedListFilterGroupResponse"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/SmartSurvey.Public.API.Helpers.PaginatedListFilterGroupResponse"
                }
              },
              "text/xml": {
                "schema": {
                  "$ref": "#/components/schemas/SmartSurvey.Public.API.Helpers.PaginatedListFilterGroupResponse"
                }
              }
            }
          },
          "403": {
            "description": "Forbidden",
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
                }
              },
              "text/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
                }
              }
            }
          },
          "404": {
            "description": "Survey not found",
            "content": {
              "text/plain": {
                "schema": {
                  "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
                }
              },
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
                }
              },
              "text/json": {
                "schema": {
                  "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
                }
              },
              "application/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
                }
              },
              "text/xml": {
                "schema": {
                  "$ref": "#/components/schemas/Microsoft.AspNetCore.Mvc.ProblemDetails"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Microsoft.AspNetCore.Mvc.ProblemDetails": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "description": "A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when\r\ndereferenced, it provide human-readable documentation for the problem type\r\n(e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be\r\n\"about:blank\".",
            "nullable": true
          },
          "title": {
            "type": "string",
            "description": "A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence\r\nof the problem, except for purposes of localization(e.g., using proactive content negotiation;\r\nsee[RFC7231], Section 3.4).",
            "nullable": true
          },
          "status": {
            "type": "integer",
            "description": "The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.",
            "format": "int32",
            "nullable": true
          },
          "detail": {
            "type": "string",
            "description": "A human-readable explanation specific to this occurrence of the problem.",
            "nullable": true
          },
          "instance": {
            "type": "string",
            "description": "A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.",
            "nullable": true
          }
        },
        "additionalProperties": {},
        "description": "A machine-readable format for specifying errors in HTTP API responses based on <see href=\"https://tools.ietf.org/html/rfc7807\" />."
      },
      "SmartSurvey.Public.API.Helpers.PaginatedListFilterGroupResponse": {
        "type": "object",
        "properties": {
          "records": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SmartSurvey.Public.API.Models.FilterGroups.FilterGroupResponse"
            },
            "description": "Gets or sets the results.",
            "nullable": true,
            "readOnly": true
          },
          "page_index": {
            "type": "integer",
            "description": "Gets or sets the index of the page.",
            "format": "int32",
            "readOnly": true
          },
          "pages": {
            "type": "integer",
            "description": "Gets or sets the total pages.",
            "format": "int32",
            "readOnly": true
          },
          "page_size": {
            "type": "integer",
            "description": "Gets or sets the size of the page.",
            "format": "int32",
            "readOnly": true
          },
          "total": {
            "type": "integer",
            "description": "Gets or sets the total number of records.",
            "format": "int32",
            "readOnly": true
          }
        },
        "additionalProperties": false,
        "description": "Paginated List helper copied from API Core and tweaked for new API"
      },
      "SmartSurvey.Public.API.Models.FilterGroups.FilterGroupResponse": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer",
            "description": "The unique id for the Filter Group",
            "format": "int32"
          },
          "type": {
            "type": "string",
            "description": "The type of resource being requested",
            "nullable": true,
            "readOnly": true
          },
          "title": {
            "type": "string",
            "description": "The name of the filter group",
            "nullable": true
          },
          "active": {
            "type": "boolean",
            "description": "Whether the filter group is active"
          },
          "is_temporary": {
            "type": "boolean",
            "description": "Whether the filter group is temporary. A temporary filter group is created automatically for a single use,\r\nsuch as an export or a filter applied without being saved, and may be deleted automatically later."
          }
        },
        "additionalProperties": false,
        "description": "DTO object for FilterGroup Response"
      }
    },
    "securitySchemes": {
      "Basic": {
        "type": "http",
        "description": "Basic Authorization",
        "scheme": "basic"
      }
    }
  },
  "security": [
    {
      "Basic": []
    }
  ]
}
```