# /smartlists

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Formstack API v2025.0",
    "version": "0.0.4"
  },
  "servers": [
    {
      "url": "https://www.formstack.com/api/v2025",
      "description": "Production server"
    },
    {
      "url": "https://staging-formstack.com/api/v2025",
      "description": "Staging server"
    },
    {
      "url": "https://dev-formstack.com/api/v2025",
      "description": "Development server"
    }
  ],
  "paths": {
    "/smartlists": {
      "get": {
        "tags": [
          "Smart List"
        ],
        "operationId": "listSmartLists",
        "parameters": [
          {
            "name": "pageNumber",
            "in": "query",
            "description": "Page number",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/GetSmartListsListApiDto/properties/pageNumber"
            }
          },
          {
            "name": "pageSize",
            "in": "query",
            "description": "Number of items per page",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/GetSmartListsListApiDto/properties/pageSize"
            }
          },
          {
            "name": "query",
            "in": "query",
            "description": "Search query",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/GetSmartListsListApiDto/properties/query"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "List of smart lists",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SmartListsListingApiDto"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "Forbidden"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "PaginationApiDto": {
        "title": "Pagination Info",
        "description": "Pagination information",
        "properties": {
          "size": {
            "description": "The amount of records returned for this page",
            "type": "integer",
            "nullable": false
          },
          "pageNumber": {
            "description": "The current page number",
            "type": "integer",
            "nullable": false
          },
          "pageSize": {
            "description": "The actual page size",
            "type": "integer",
            "nullable": false
          },
          "totalElements": {
            "description": "The total amount of resources available",
            "type": "integer",
            "nullable": false
          },
          "totalPages": {
            "description": "The total amount of pages available, based on the pageSize",
            "type": "integer",
            "nullable": false
          }
        },
        "type": "object"
      },
      "SmartListPreviewApiDto": {
        "title": "Smart List Preview",
        "description": "Smart List preview response for listings",
        "properties": {
          "id": {
            "description": "The ID of the smart list",
            "type": "integer",
            "nullable": false
          },
          "name": {
            "description": "Name of the smart list",
            "type": "string",
            "nullable": false
          },
          "useImages": {
            "description": "Whether the smart list uses images",
            "type": "boolean",
            "nullable": false
          },
          "useSeparateValues": {
            "description": "Whether the smart list uses separate values",
            "type": "boolean",
            "nullable": false
          },
          "created": {
            "description": "Date when the smart list was created (ISO 8601 format)",
            "type": "string",
            "format": "date-time",
            "example": "2023-12-01T10:30:00Z",
            "nullable": false
          },
          "updated": {
            "description": "Date when the smart list was last updated (ISO 8601 format)",
            "type": "string",
            "format": "date-time",
            "example": "2023-12-01T15:45:00Z",
            "nullable": false
          }
        },
        "type": "object"
      },
      "SmartListsListingApiDto": {
        "title": "Smart Lists Listing",
        "description": "Smart Lists listing response",
        "properties": {
          "page": {
            "$ref": "#/components/schemas/PaginationApiDto"
          },
          "smartLists": {
            "description": "List of smart lists",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SmartListPreviewApiDto"
            },
            "nullable": false
          }
        },
        "type": "object"
      },
      "GetSmartListsListApiDto": {
        "title": "Get Smart Lists List Input",
        "description": "Parameters for retrieving a paginated list of Smart Lists",
        "properties": {
          "pageNumber": {
            "description": "Page to use when paginating through items.",
            "type": "integer",
            "minimum": 1,
            "nullable": true
          },
          "pageSize": {
            "description": "Number of items to return per page.",
            "type": "integer",
            "default": 50,
            "maximum": 500,
            "minimum": 10,
            "nullable": true
          },
          "query": {
            "description": "Optional search query to filter Smart Lists by name",
            "type": "string",
            "example": "marketing lists",
            "nullable": true
          }
        },
        "type": "object"
      }
    }
  },
  "tags": [
    {
      "name": "Smart List",
      "description": "Smart Lists are reusable sets of options that can be shared across fields and forms, so option sets are maintained in one place rather than per field. Use these endpoints to list smart lists and to create, retrieve, update, and delete a smart list."
    }
  ]
}
```