--- title: List Exclusion Groups slug: feature-experimentation/api/kecK-list-exclusion-groups docTags: createdAt: 2026-10-01T19:58:02.336Z --- { "id": "zVhudITSjDq30-957XdRd", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://api.optimizely.com/v2/groups", "servers": [ { "url": "https://api.optimizely.com/v2/groups" } ], "name": "List Exclusion Groups", "description": "List Exclusion Groups under 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 ID of the Project you would like to list all Exclusion Groups for", "format": "int64" } ], "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 Exclusion Groups in the specified Project", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "array", "description": "", "customType": "Group[]", "schema": [ { "name": "archived", "kind": "optional", "type": "boolean", "description": "Whether the group is archived" }, { "name": "created", "kind": "optional", "type": "string", "readOnly": true, "description": "The time when the Exclusion Group was initially created", "format": "date-time" }, { "name": "description", "kind": "optional", "type": "string", "description": "The description for an Exclusion Group" }, { "name": "entities", "kind": "optional", "type": "array", "description": "Array of Group Entities in the Exclusion Group", "modelRef": "#/components/schemas/GroupEntity", "customType": "GroupEntity[]", "schema": [ { "name": "id", "kind": "required", "type": "integer", "description": "The unique identifier for the Group Entity", "example": 3000 }, { "name": "kind", "kind": "required", "type": "string", "description": "The kind of the Group Entity", "enum": [ "Campaign", "Experiment" ] }, { "name": "weight", "kind": "required", "type": "integer", "description": "

The weight of the Group Entity. The weight is a value between 0 and 10000. An entity with weight 5000 will receive 50% of this group's traffic

", "example": 1000 } ] }, { "name": "id", "kind": "optional", "type": "integer", "readOnly": true, "description": "The unique identifier for the Exclusion Group", "example": 3000, "format": "int64" }, { "name": "last_modified", "kind": "optional", "type": "string", "readOnly": true, "description": "The last time the Exclusion Group was modified", "format": "date-time" }, { "name": "name", "kind": "required", "type": "string", "description": "Name of the Exclusion Group", "example": "Homepage Group" }, { "name": "project_id", "kind": "required", "type": "integer", "description": "The Project the Exclusion Group is in", "example": 1000, "format": "int64" } ], "modelRef": "#/components/schemas/Group", "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 permission to access the Exclusion Groups in 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": "Exclusion Groups 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": "R6845rKqjeNXUB_N6FAZg", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url 'https://api.optimizely.com/v2/groups?per_page=25&page=1&project_id=integer%3Cint64%3E' \\\n --header 'accept: application/json'" }, { "id": "oiW5W1zwx8HZQbIBthHn5", "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/groups?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": "FcKcN9SMbb6ZeQZgW-uYx", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.optimizely.com/v2/groups?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": "o_IP6baIdt8sJvEeBt6QZ", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.optimizely.com/v2/groups?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": "R6845rKqjeNXUB_N6FAZg" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// Return all Exclusion Groups in the specified Project\n[\n {\n \"archived\": false,\n \"created\": \"\",\n \"description\": \"\",\n \"entities\": [\n {\n \"id\": 3000,\n \"kind\": \"\",\n \"weight\": 1000\n }\n ],\n \"id\": 3000,\n \"last_modified\": \"\",\n \"name\": \"Homepage Group\",\n \"project_id\": 1000\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 permission to access the Exclusion Groups in the specified Project\n{\n \"code\": \"\",\n \"message\": \"\",\n \"messages\": {},\n \"uuid\": \"\"\n}" }, { "id": "response-3-404", "language": "404", "code": "// Exclusion Groups 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": "" } ] }