--- title: List all approval policies for a project across all environments slug: feature-experimentation/api/list-all-approval-policies-for-a-project-across-all-environments docTags: createdAt: 2026-10-13T18:16:15.508Z --- { "id": "Flb-wi-jvLnzUX5-6nhLm", "type": "api-oas-v2", "data": { "method": "GET", "url": "http://localhost:3002//projects/{project_id}/policies", "servers": [ { "url": "http://localhost:3002//projects/{project_id}/policies", "description": "Local server" }, { "url": "https://api.app.optimizely.com/flags-scheduling/projects/{project_id}/policies", "description": "Production server" } ], "name": "List all approval policies for a project across all environments", "description": "", "contentType": "application/json", "request": { "pathParameters": [ { "kind": "required", "name": "project_id", "type": "integer", "description": "" } ], "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": "The max number of items to include per page or results.", "format": "int64" }, { "kind": "optional", "name": "page", "type": "integer", "description": "

Bypass page_token to jump to specific page

", "format": "int64" }, { "kind": "optional", "name": "query", "type": "string", "description": "Search input to filter policies by name" }, { "kind": "optional", "name": "environment_id", "type": "integer", "description": "Filter policies by environment ID" }, { "kind": "optional", "name": "sort", "type": "string", "description": "

Sort by column

. Allowed columns: name, environment_id, environment_name, entity_type, is_default, created_at. Example: 'name
'. environment_name sorts alphabetically by the environment's name rather than its id.

" } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "BearerAuth", "name": "BearerAuth", "kind": "optional", "type": "http", "description": "

To get a personal token, see https://docs.developers.optimizely.com/web/docs/personal-token

", "scheme": "bearer" } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "Successful Response", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "PaginatedPolicyResponse", "schema": [ { "name": "items", "kind": "required", "type": "array", "description": "List of policies", "modelRef": "#/components/schemas/PolicyResponse", "customType": "PolicyResponse[]", "schema": [ { "name": "id", "kind": "required", "type": "integer", "description": "The unique identifier for the policy" }, { "name": "name", "kind": "required", "type": "string", "description": "The name of the policy" }, { "name": "description", "kind": "optional", "type": "string", "description": "A description of the policy" }, { "name": "approver_assignment_mode", "kind": "optional", "type": "string", "description": "How approvers are assigned to approval requests", "modelRef": "#/components/schemas/ApproverAssignmentMode", "customType": "ApproverAssignmentMode", "schema": [] }, { "name": "entity_type", "kind": "required", "type": "string", "description": "The policy's entity type", "enum": [ "flag", "ruleset" ] }, { "name": "environment_id", "kind": "required", "type": "integer", "description": "The environment this policy belongs to" }, { "name": "project_id", "kind": "required", "type": "integer", "description": "The project this policy belongs to" }, { "name": "is_default", "kind": "required", "type": "boolean", "description": "

Whether this is the environment-level default policy

" }, { "name": "default_preferences", "kind": "required", "type": "object", "description": "Change surfaces that require approval", "modelRef": "#/components/schemas/PolicyDefaultPreferences", "customType": "PolicyDefaultPreferences", "schema": [ { "name": "audiences", "kind": "optional", "type": "boolean", "description": "" }, { "name": "metrics", "kind": "optional", "type": "boolean", "description": "" }, { "name": "ramp_perc", "kind": "optional", "type": "boolean", "description": "" }, { "name": "rules", "kind": "optional", "type": "boolean", "description": "" }, { "name": "ruleset", "kind": "optional", "type": "boolean", "description": "" }, { "name": "variations", "kind": "optional", "type": "boolean", "description": "" } ] }, { "name": "approvers", "kind": "required", "type": "array", "description": "List of approvers for this policy", "modelRef": "#/components/schemas/PolicyApprover", "customType": "PolicyApprover[]", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of approver", "enum": [ "user", "team" ] }, { "name": "email", "kind": "optional", "type": "string", "description": "

Email of the approver (when type is user)

" }, { "name": "team_id", "kind": "optional", "type": "string", "description": "

ID of the approver team (when type is team)

" }, { "name": "team_name", "kind": "optional", "type": "string", "description": "

Name of the approver team (when type is team)

" } ] }, { "name": "notification_recipients", "kind": "optional", "type": "array", "description": "

List of notification recipients (users and teams)

", "modelRef": "#/components/schemas/PolicyApprover", "customType": "PolicyApprover[]", "schema": [ { "name": "type", "kind": "required", "type": "string", "description": "The type of approver", "enum": [ "user", "team" ] }, { "name": "email", "kind": "optional", "type": "string", "description": "

Email of the approver (when type is user)

" }, { "name": "team_id", "kind": "optional", "type": "string", "description": "

ID of the approver team (when type is team)

" }, { "name": "team_name", "kind": "optional", "type": "string", "description": "

Name of the approver team (when type is team)

" } ] }, { "name": "entities", "kind": "required", "type": "array", "description": "Entity approval settings associated with this policy", "modelRef": "#/components/schemas/PolicyEntity", "customType": "PolicyEntity[]", "schema": [ { "name": "id", "kind": "required", "type": "integer", "description": "The entity record ID" }, { "name": "entity_id", "kind": "required", "type": "integer", "description": "The flag ID" }, { "name": "entity_key", "kind": "required", "type": "string", "description": "The flag key" }, { "name": "type", "kind": "required", "type": "string", "description": "

The entity type (e.g. flag)

" }, { "name": "preferences", "kind": "required", "type": "map", "description": "Preference overrides for this entity", "example": "", "customType": "map", "schema": [] }, { "name": "archived", "kind": "required", "type": "boolean", "description": "Whether the entity is archived" } ] }, { "name": "created_at", "kind": "required", "type": "string", "description": "Timestamp when the policy was created", "format": "date-time" }, { "name": "updated_at", "kind": "required", "type": "string", "description": "Timestamp when the policy was last updated", "format": "date-time" }, { "name": "revision", "kind": "optional", "type": "integer", "description": "Revision number for optimistic locking" }, { "name": "archived", "kind": "optional", "type": "boolean", "description": "Whether the policy is archived" } ] }, { "name": "count", "kind": "required", "type": "integer", "description": "Number of items in the current page" }, { "name": "page", "kind": "required", "type": "integer", "description": "Current page number" }, { "name": "total_count", "kind": "required", "type": "integer", "description": "Total number of policies across all pages" }, { "name": "total_pages", "kind": "required", "type": "integer", "description": "Total number of pages" }, { "name": "has_more", "kind": "required", "type": "boolean", "description": "Whether there are more pages" }, { "name": "first_url", "kind": "optional", "type": "string", "nullable": true, "description": "URL for the first page of policies" }, { "name": "last_url", "kind": "optional", "type": "string", "nullable": true, "description": "URL for the last page of policies" }, { "name": "prev_url", "kind": "optional", "type": "string", "nullable": true, "description": "URL for the previous page of policies" }, { "name": "next_url", "kind": "optional", "type": "string", "nullable": true, "description": "URL for the next page of policies" } ], "modelRef": "#/components/schemas/PaginatedPolicyResponse", "isExpanded": true } ] }, { "statusCode": "401", "description": "Not Authenticated", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ErrorResponse", "schema": [ { "name": "details", "kind": "required", "type": "string", "description": "Details of Error." }, { "name": "status", "kind": "required", "type": "integer", "description": "Status code of the response.", "example": 400 } ], "modelRef": "#/components/schemas/ErrorResponse", "isExpanded": true } ] } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "440zevfXuEA90F-1fRYP4", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url http://localhost:3002//projects/{project_id}/policies \\\n --header 'accept: application/json'" }, { "id": "M-LlpHioWYCg9O_jpM1cS", "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(\"http://localhost:3002//projects/{project_id}/policies\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "iegejP2IZwXYGTvvuVlMq", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"http://localhost:3002//projects/{project_id}/policies\")\n\nhttp = Net::HTTP.new(url.host, url.port);\nrequest = Net::HTTP::Get.new(url)\nrequest[\"accept\"] = \"application/json\"\nrequest[\"content-type\"] = \"application/json\"\n\nresponse = http.request(request)\nputs response.read_body\n" }, { "id": "VnP7T7fIyWEYcSFtsVb5b", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"http://localhost:3002//projects/{project_id}/policies\"\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": "440zevfXuEA90F-1fRYP4" }, "results": { "languages": [ { "id": "OufhTA4SH_wJQy_B8auJZ", "language": "200", "code": "// Successful Response\n{\n \"items\": [\n {\n \"id\": 0,\n \"name\": \"\",\n \"description\": \"\",\n \"approver_assignment_mode\": \"\",\n \"entity_type\": \"\",\n \"environment_id\": 0,\n \"project_id\": 0,\n \"is_default\": false,\n \"default_preferences\": {\n \"audiences\": false,\n \"metrics\": false,\n \"ramp_perc\": false,\n \"rules\": false,\n \"ruleset\": false,\n \"variations\": false\n },\n \"approvers\": [\n {\n \"type\": \"\",\n \"email\": \"\",\n \"team_id\": \"\",\n \"team_name\": \"\"\n }\n ],\n \"notification_recipients\": [\n {\n \"type\": \"\",\n \"email\": \"\",\n \"team_id\": \"\",\n \"team_name\": \"\"\n }\n ],\n \"entities\": [\n {\n \"id\": 0,\n \"entity_id\": 0,\n \"entity_key\": \"\",\n \"type\": \"\",\n \"preferences\": \"\",\n \"archived\": false\n }\n ],\n \"created_at\": \"\",\n \"updated_at\": \"\",\n \"revision\": 0,\n \"archived\": false\n }\n ],\n \"count\": 0,\n \"page\": 0,\n \"total_count\": 0,\n \"total_pages\": 0,\n \"has_more\": false,\n \"first_url\": \"\",\n \"last_url\": \"\",\n \"prev_url\": \"\",\n \"next_url\": \"\"\n}" }, { "id": "yMK6HhZ7jmdiy-WHYXpj6", "language": "401", "code": "// Not Authenticated\n{\n \"details\": \"\",\n \"status\": 400\n}" } ], "selectedLanguageId": "OufhTA4SH_wJQy_B8auJZ" } }, "children": [ { "text": "" } ] }