# /smartlists/{smartListId}/options

# 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/{smartListId}/options": {
      "get": {
        "tags": [
          "Smart List Options"
        ],
        "operationId": "listSmartListOptions",
        "parameters": [
          {
            "name": "smartListId",
            "in": "path",
            "description": "ID of the smart list",
            "required": true,
            "schema": {
              "type": "integer"
            }
          },
          {
            "name": "pageNumber",
            "in": "query",
            "description": "Page number",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/GetSmartListOptionsListApiDto/properties/pageNumber"
            }
          },
          {
            "name": "pageSize",
            "in": "query",
            "description": "Number of items per page",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/GetSmartListOptionsListApiDto/properties/pageSize"
            }
          },
          {
            "name": "query",
            "in": "query",
            "description": "Search query to filter options by label",
            "required": false,
            "schema": {
              "$ref": "#/components/schemas/GetSmartListOptionsListApiDto/properties/query"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "List of smart list options",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SmartListOptionsListingApiDto"
                }
              }
            }
          },
          "401": {
            "description": "Unauthorized"
          },
          "403": {
            "description": "Forbidden"
          },
          "404": {
            "description": "SmartList not found"
          }
        }
      }
    }
  },
  "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"
      },
      "SmartListOptionDetailedApiDto": {
        "title": "Smart List Option Details",
        "description": "Smart List option details response",
        "properties": {
          "id": {
            "description": "The ID of the smart list option",
            "type": "integer",
            "nullable": false
          },
          "label": {
            "description": "Display label of the smart list option",
            "type": "string",
            "nullable": false
          },
          "value": {
            "description": "Value of the smart list option (used when separate values are enabled)",
            "type": "string",
            "nullable": false
          },
          "imageUrl": {
            "description": "URL of the option image if available",
            "type": "string",
            "nullable": true
          },
          "sort": {
            "description": "Sort order of the option",
            "type": "integer",
            "nullable": false
          },
          "created": {
            "description": "Date when the option was created (ISO 8601 format)",
            "type": "string",
            "format": "date-time",
            "example": "2023-12-01T10:30:00Z",
            "nullable": false
          },
          "updated": {
            "description": "Date when the option was last updated (ISO 8601 format)",
            "type": "string",
            "format": "date-time",
            "example": "2023-12-01T15:45:00Z",
            "nullable": false
          }
        },
        "type": "object"
      },
      "SmartListOptionsListingApiDto": {
        "title": "SmartList Options Listing",
        "description": "SmartList options listing response",
        "properties": {
          "page": {
            "$ref": "#/components/schemas/PaginationApiDto"
          },
          "options": {
            "description": "List of smart list options",
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/SmartListOptionDetailedApiDto"
            },
            "nullable": false
          }
        },
        "type": "object"
      },
      "GetSmartListOptionsListApiDto": {
        "title": "Get SmartList Options List Input",
        "description": "Input parameters for getting SmartList options list",
        "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": "Search query to filter options by label",
            "type": "string",
            "nullable": true
          }
        },
        "type": "object"
      }
    }
  },
  "tags": [
    {
      "name": "Smart List Options",
      "description": "Smart List Options are the individual entries that make up a Smart List. Use these endpoints to list a smart list's options, add, retrieve, update, and delete an option, clear all of a list's options, bulk-add a set of options to a list, and upload or remove an option's image."
    }
  ]
}
```