--- title: List Pages slug: web-experimentation/api/list-pages docTags: createdAt: 2026-10-02T13:15:18.296Z --- { "id": "bvMIUsf4MTSVmyMVPQKly", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://api.optimizely.com/v2/pages", "servers": [ { "url": "https://api.optimizely.com/v2/pages" } ], "name": "List Pages", "description": "List all Pages for a Project", "contentType": "application/json", "request": { "pathParameters": [], "headerParameters": [ { "name": "accept", "type": "string", "kind": "optional", "description": "Generated from available response content types", "enum": [ "application/json" ], "default": "application/json" } ], "queryParameters": [ { "kind": "optional", "name": "per_page", "type": "integer", "description": "Optional pagination argument that specifies the maximum number of objects to return per request", "default": 25, "maximum": 100 }, { "kind": "optional", "name": "page", "type": "integer", "description": "Optional pagination argument that specifies the page to return. If you have 140 objects and you choose to return 100 objects per page you will be able to access the last 40 objects on page 2. The default value is 1.\n", "default": 1 }, { "kind": "required", "name": "project_id", "type": "integer", "description": "The Project ID of the Project you would like to list all Pages for", "format": "int64" }, { "kind": "optional", "name": "include_single_use", "type": "boolean", "description": "

Whether or not to include single-use Pages (those generated for Campaign URL targeting) alongside regular Pages. If this parameter is not provided it will default to false

", "default": false } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "apiKey", "name": "apiKey", "kind": "optional", "type": "http", "scheme": "bearer" }, { "id": "OAuth2", "name": "OAuth2", "kind": "optional", "type": "oauth2", "description": "

Write applications that authenticate with the REST API via OAuth 2.0. Or, to authenticate using a personal token, see https://docs.developers.optimizely.com/web/docs/personal-token

", "oauth2Flows": { "authorizationCode": { "authorizationUrl": "https://app.optimizely.com/oauth2/authorize", "tokenUrl": "https://app.optimizely.com/oauth2/token", "scopes": { "all": "Full access to your account" } } }, "requiredScopes": [ "read", "write" ] } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Return Project Pages info", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "array", "description": "", "customType": "Page[]", "schema": [ { "name": "activation_code", "kind": "optional", "type": "string", "description": "

Stringified Javascript function that determines when the Page is activated. Only required when activation_type is 'polling' or 'callback'.

", "example": "function callbackFn(activate, options) { activate(); }" }, { "name": "activation_type", "kind": "optional", "type": "string", "description": "

Page activation type is a trigger that determines when the page is activated. Triggers tell Optimizely when to start checking whether certain conditions are true\n'Immediate' activation mode activates the page as soon as the snippet loads.\n'Polling' activation mode polls every 50ms until 'activation_code' evaluates to True, then activates the page.\n'Callback' activation mode activates the page when the event defined by 'activation_code' is triggered.\n'Manual' activation mode requires code within the subject app to explicitly trigger page activation.\n'DOM Changed' sets the page to trigger when the DOM changes Learn more.\n'URL Changed' sets the page to trigger when the URL changes Learn more.

", "example": "callback", "enum": [ "immediate", "manual", "polling", "callback", "dom_changed", "url_changed" ] }, { "name": "archived", "kind": "optional", "type": "boolean", "description": "Whether the Page has been archived", "default": false }, { "name": "category", "kind": "optional", "type": "string
", "description": "The category this Page is grouped under", "default": "other", "enum": [ "article", "cart", "category", "checkout", "home", "landing_page", "pricing", "product_detail", "search_results", "other" ] }, { "name": "conditions", "kind": "optional", "type": "string", "description": "

Stringified array of the conditions that activate the Page. The array contains Page Condition JSON dicts joined by \"and\" and \"or\".\nEach individual Page Condition dict has format {\"type\": \"url\", \"match_type\": <match_type>, \"value\": } where match_types are:\n\"simple\" match type will match if \"value\" matches the hostname and path of the Page URL.\n\"exact\" match type will match only an exact string match between \"value\" and the Page URL.\n\"substring\" match type will match if \"value\" is a substring of the Page URL.\n\"regex\" match type will match if \"value\" is a regular expression match for the Page URL.

", "example": "[\"and\", {\"type\": \"url\", \"match_type\": \"substring\", \"value\": \"optimize\"}]" }, { "name": "created", "kind": "optional", "type": "string", "readOnly": true, "description": "Date created", "format": "date-time" }, { "name": "edit_url", "kind": "required", "type": "string", "description": "URL of the Page", "example": "https://www.optimizely.com" }, { "name": "experiment_count", "kind": "optional", "type": "integer", "readOnly": true, "description": "

Number of experiments that reference this Page across all statuses (running, paused, draft, archived). Computed by the upstream service.

", "example": 3, "format": "int64" }, { "name": "id", "kind": "optional", "type": "integer", "readOnly": true, "description": "The unique identifier of the Page", "example": 4000, "format": "int64" }, { "name": "key", "kind": "optional", "type": "string", "description": "Unique string identifier for this Page within the Project", "example": "home_page", "maxLength": 500, "pattern": "^[a-zA-Z0-9_]+$" }, { "name": "last_modified", "kind": "optional", "type": "string", "readOnly": true, "description": "Date last modified", "format": "date-time" }, { "name": "name", "kind": "required", "type": "string", "description": "Name of the Page", "example": "Home Page" }, { "name": "page_type", "kind": "optional", "type": "string", "description": "Type of Page", "enum": [ "single_url", "url_set", "global" ] }, { "name": "project_id", "kind": "required", "type": "integer", "description": "ID of the Page's Project", "example": 1000, "format": "int64" }, { "name": "single_use", "kind": "optional", "type": "boolean", "readOnly": true, "description": "

Whether the Page is a single-use page created for URL targeting

" } ], "modelRef": "#/components/schemas/Page", "isExpanded": true } ] }, { "statusCode": "400", "description": "Invalid ID supplied", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "Error", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "" }, { "name": "message", "kind": "optional", "type": "string", "description": "" }, { "name": "messages", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] }, { "name": "uuid", "kind": "optional", "type": "string", "description": "", "format": "uuid" } ], "modelRef": "#/components/schemas/Error", "isExpanded": true } ] }, { "statusCode": "403", "description": "You do not have permission to access the specified pages", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "Error", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "" }, { "name": "message", "kind": "optional", "type": "string", "description": "" }, { "name": "messages", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] }, { "name": "uuid", "kind": "optional", "type": "string", "description": "", "format": "uuid" } ], "modelRef": "#/components/schemas/Error", "isExpanded": true } ] }, { "statusCode": "404", "description": "Pages not found", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "Error", "schema": [ { "name": "code", "kind": "optional", "type": "string", "description": "" }, { "name": "message", "kind": "optional", "type": "string", "description": "" }, { "name": "messages", "kind": "optional", "type": "object", "description": "", "example": "", "schema": [] }, { "name": "uuid", "kind": "optional", "type": "string", "description": "", "format": "uuid" } ], "modelRef": "#/components/schemas/Error", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "FIYErXf_BegppyP496ngX", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url 'https://api.optimizely.com/v2/pages?per_page=25&page=1&project_id=integer%3Cint64%3E&include_single_use=boolean' \\\n --header 'accept: application/json'" }, { "id": "KLwEI_D-ASS2Sb6rW-j9J", "language": "javascript", "label": "javascript", "code": "var myHeaders = new Headers();\nmyHeaders.append(\"accept\", \"application/json\");\nmyHeaders.append(\"content-type\", \"application/json\");\n\nvar requestOptions = {\n method: 'GET',\n headers: myHeaders,\n redirect: 'follow'\n};\n\nfetch(\"https://api.optimizely.com/v2/pages?per_page=25&page=1&project_id=integer&include_single_use=boolean\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "ILjkYRGeWG-PMuXkBOKZ_", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.optimizely.com/v2/pages?per_page=25&page=1&project_id=integer&include_single_use=boolean\")\n\nhttps = Net::HTTP.new(url.host, url.port)\nhttps.use_ssl = true\n\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = https.request(request)\nputs response.read_body\n" }, { "id": "egMgFGkpR6Sc0jfviYqaC", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.optimizely.com/v2/pages?per_page=25&page=1&project_id=integer&include_single_use=boolean\"\n\npayload = {}\nheaders = {\n 'accept': 'application/json',\n 'content-type': 'application/json'\n}\n\nresponse = requests.request(\"GET\", url, headers=headers, data=payload)\n\nprint(response.text)\n" } ], "selectedLanguageId": "FIYErXf_BegppyP496ngX" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// Return Project Pages info\n[\n {\n \"activation_code\": \"function callbackFn(activate, options) { activate(); }\",\n \"activation_type\": \"callback\",\n \"archived\": false,\n \"category\": \"\",\n \"conditions\": \"[\\\"and\\\", {\\\"type\\\": \\\"url\\\", \\\"match_type\\\": \\\"substring\\\", \\\"value\\\": \\\"optimize\\\"}]\",\n \"created\": \"\",\n \"edit_url\": \"https://www.optimizely.com\",\n \"experiment_count\": 3,\n \"id\": 4000,\n \"key\": \"home_page\",\n \"last_modified\": \"\",\n \"name\": \"Home Page\",\n \"page_type\": \"\",\n \"project_id\": 1000,\n \"single_use\": false\n }\n]" }, { "id": "response-1-400", "language": "400", "code": "// Invalid ID supplied\n{\n \"code\": \"\",\n \"message\": \"\",\n \"messages\": {},\n \"uuid\": \"\"\n}" }, { "id": "response-2-403", "language": "403", "code": "// You do not have permission to access the specified pages\n{\n \"code\": \"\",\n \"message\": \"\",\n \"messages\": {},\n \"uuid\": \"\"\n}" }, { "id": "response-3-404", "language": "404", "code": "// Pages not found\n{\n \"code\": \"\",\n \"message\": \"\",\n \"messages\": {},\n \"uuid\": \"\"\n}" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "" } ] }