--- title: List Audiences slug: feature-experimentation/api/list-audiences docTags: createdAt: 2026-10-01T19:58:02.336Z --- { "id": "67cQrnF-dwSUA9NN3zIUU", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://api.optimizely.com/v2/audiences", "servers": [ { "url": "https://api.optimizely.com/v2/audiences" } ], "name": "List Audiences", "description": "List Audiences 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 Audiences for", "format": "int64" }, { "kind": "optional", "name": "for_journey", "type": "boolean", "description": "Filter audiences by journey status" }, { "kind": "optional", "name": "archived", "type": "boolean", "description": "Filter audiences by archived status" } ], "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 all Audiences", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "array", "description": "", "customType": "Audience[]", "schema": [ { "name": "archived", "kind": "optional", "type": "boolean", "description": "Whether the Audience has been archived", "default": false }, { "name": "conditions", "kind": "optional", "type": "string", "description": "A string defining the targeting rules for an Audience", "example": "[\"and\", {\"type\": \"language\", \"value\": \"es\"}, {\"type\": \"location\", \"value\": \"US-CA-SANFRANCISCO\"}]" }, { "name": "created", "kind": "optional", "type": "string", "readOnly": true, "description": "The time the Audience was initially created", "format": "date-time" }, { "name": "description", "kind": "optional", "type": "string", "description": "A short description of the Audience", "example": "People that speak spanish and are in San Francisco" }, { "name": "experiment_count", "kind": "optional", "type": "integer", "readOnly": true, "description": "

Number of experiments by audience_id

", "example": 123, "format": "int64" }, { "name": "for_journey", "kind": "optional", "type": "boolean", "description": "Whether the Audience has been part of journey or not", "default": false }, { "name": "id", "kind": "optional", "type": "integer", "readOnly": true, "description": "The unique identifier for the Audience", "example": 5000, "format": "int64" }, { "name": "is_classic", "kind": "optional", "type": "boolean", "description": "

Whether or not Audience is a classic Audience. If true, the Audience is only compatible with classic Experiments. Otherwise, the Audience may be used in Optimizely X Campaigns.

" }, { "name": "last_modified", "kind": "optional", "type": "string", "readOnly": true, "description": "The last time the Audience was modified", "format": "date-time" }, { "name": "name", "kind": "optional", "type": "string", "description": "The name of the Audience", "example": "Spanish speaking San Franciscans" }, { "name": "project_id", "kind": "required", "type": "integer", "description": "The ID of the Project the Audience was created in", "example": 1000, "format": "int64" }, { "name": "segmentation", "kind": "optional", "type": "boolean", "description": "

True if the Audience is available for segmentation on the results page (Audiences can only be used for segmentation in Optimizely Classic). Set to False if you intend to use this Audience only in Optimizely X. Note that a maximum of 10 Audiences can have segmentation set to True in any given Optimizely Classic project.

", "default": false } ], "modelRef": "#/components/schemas/Audience", "isExpanded": true } ] }, { "statusCode": "401", "description": "Invalid credentials", "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 access to Audiences under the specified Project", "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": "Project 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 } ] }, { "statusCode": "default", "description": "Unexpected error", "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": "LmOHcMKTSGvVjl7QGMEEK", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url 'https://api.optimizely.com/v2/audiences?per_page=25&page=1&project_id=integer%3Cint64%3E' \\\n --header 'accept: application/json'" }, { "id": "OCpQt_lDWcasiA9iOuE_z", "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/audiences?per_page=25&page=1&project_id=integer\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "7phv1SWKnSQBYI8gtMZw5", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.optimizely.com/v2/audiences?per_page=25&page=1&project_id=integer\")\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": "Mh2qu5VzHAsGzhz7ZIoeF", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.optimizely.com/v2/audiences?per_page=25&page=1&project_id=integer\"\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": "LmOHcMKTSGvVjl7QGMEEK" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// Return all Audiences\n[\n {\n \"archived\": false,\n \"conditions\": \"[\\\"and\\\", {\\\"type\\\": \\\"language\\\", \\\"value\\\": \\\"es\\\"}, {\\\"type\\\": \\\"location\\\", \\\"value\\\": \\\"US-CA-SANFRANCISCO\\\"}]\",\n \"created\": \"\",\n \"description\": \"People that speak spanish and are in San Francisco\",\n \"experiment_count\": 123,\n \"for_journey\": false,\n \"id\": 5000,\n \"is_classic\": false,\n \"last_modified\": \"\",\n \"name\": \"Spanish speaking San Franciscans\",\n \"project_id\": 1000,\n \"segmentation\": false\n }\n]" }, { "id": "response-1-401", "language": "401", "code": "// Invalid credentials\n{\n \"code\": \"\",\n \"message\": \"\",\n \"messages\": {},\n \"uuid\": \"\"\n}" }, { "id": "response-2-403", "language": "403", "code": "// You do not have access to Audiences under the specified Project\n{\n \"code\": \"\",\n \"message\": \"\",\n \"messages\": {},\n \"uuid\": \"\"\n}" }, { "id": "response-3-404", "language": "404", "code": "// Project not found\n{\n \"code\": \"\",\n \"message\": \"\",\n \"messages\": {},\n \"uuid\": \"\"\n}" }, { "id": "response-4-default", "language": "default", "code": "// Unexpected error\n{\n \"code\": \"\",\n \"message\": \"\",\n \"messages\": {},\n \"uuid\": \"\"\n}" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "" } ] }