--- title: List Attributes slug: web-experimentation/api/list-attributes docTags: createdAt: 2026-10-02T13:15:18.296Z --- { "id": "fZlv_ymSgbnYV9qV_bCr6", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://api.optimizely.com/v2/attributes", "servers": [ { "url": "https://api.optimizely.com/v2/attributes" } ], "name": "List Attributes", "description": "List Attributes 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 Attributes 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 Attributes in the specified Project", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "array", "description": "", "customType": "Attribute[]", "schema": [ { "name": "archived", "kind": "optional", "type": "boolean", "description": "Whether or not the Attribute has been archived", "default": false }, { "name": "condition_type", "kind": "optional", "type": "string", "readOnly": true, "description": "

Whether this Attribute is a custom dimension or custom attribute. If this is a custom dimension, it belongs to an Optimizely Classic experiment and is read-only.

", "default": "custom_attribute", "enum": [ "custom_attribute", "custom_dimension" ] }, { "name": "description", "kind": "optional", "type": "string", "description": "A short description of the Attribute" }, { "name": "id", "kind": "optional", "type": "integer", "readOnly": true, "description": "The unique identifier for the Attribute", "format": "int64" }, { "name": "key", "kind": "required", "type": "string", "description": "Unique string identifier for this Attribute within the project", "example": "subscriber_status", "maxLength": 64, "pattern": "^[a-zA-Z0-9_\\- .]+$" }, { "name": "last_modified", "kind": "optional", "type": "string", "readOnly": true, "description": "The last time the Attribute was modified", "format": "date-time" }, { "name": "name", "kind": "optional", "type": "string", "description": "

The name of the Attribute. For Full Stack projects, the name will be set to the value of the key.

", "example": "Subscriber Status" }, { "name": "project_id", "kind": "required", "type": "integer", "description": "The ID of the project the Attribute belongs to", "example": 17738411154, "format": "int64" } ], "modelRef": "#/components/schemas/Attribute", "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 to the Attributes 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": "Attributes 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": "COsEehafpWA0obZaC5jaf", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url 'https://api.optimizely.com/v2/attributes?per_page=25&page=1&project_id=integer%3Cint64%3E' \\\n --header 'accept: application/json'" }, { "id": "Y52FmnOVPeEGGwTrVYoRC", "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/attributes?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": "lHFGldyo9eUnbncmV-Rjv", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.optimizely.com/v2/attributes?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": "ODDs0vvBYGhxstXh8hbWG", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.optimizely.com/v2/attributes?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": "COsEehafpWA0obZaC5jaf" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// Return all Attributes in the specified Project\n[\n {\n \"archived\": false,\n \"condition_type\": \"\",\n \"description\": \"\",\n \"id\": \"\",\n \"key\": \"subscriber_status\",\n \"last_modified\": \"\",\n \"name\": \"Subscriber Status\",\n \"project_id\": 17738411154\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 to the Attributes in the specified Project\n{\n \"code\": \"\",\n \"message\": \"\",\n \"messages\": {},\n \"uuid\": \"\"\n}" }, { "id": "response-3-404", "language": "404", "code": "// Attributes 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": "" } ] }