--- title: List property formats slug: cms-saas/api/list-property-formats docTags: createdAt: 2026-08-28T15:28:05.479Z --- { "id": "9KY4V7ll_B7cGXqJ8krtj", "type": "api-oas-v2", "data": { "method": "GET", "url": "https://api.cms.optimizely.com/v1/propertyformats", "servers": [ { "url": "https://api.cms.optimizely.com/v1/propertyformats", "description": "Optimizely CMS API" } ], "name": "List property formats", "description": "List all property formats using the provided options.", "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": "pageIndex", "type": "integer", "description": "Zero based index of the page that should be retrieved.", "format": "int32", "minimum": 0, "maximum": 10000 }, { "kind": "optional", "name": "pageSize", "type": "integer", "description": "The maximum items per page that should be retrieved.", "format": "int32", "minimum": 1, "maximum": 10000 } ], "bodyDataParameters": [], "formDataParameters": [], "oAuthParameters": [ { "id": "apiAuth", "name": "apiAuth", "kind": "optional", "type": "oauth2", "description": "Use this scheme to generate an access token that can be used to access the API.", "oauth2Flows": { "clientCredentials": { "tokenUrl": "https://api.cms.optimizely.com/oauth/token", "scopes": { "api:admin": "Grants full administrative access to the API" } } }, "requiredScopes": [ "api:admin" ] } ], "cookieParameters": [] }, "responses": [ { "statusCode": "200", "description": "OK", "jsonExample": "", "isExpanded": true, "schema": [ { "kind": "optional", "type": "object", "description": "

A single page of items in a paged collection, including paging metadata such as the current page index, page size, and an estimated total item count.

", "customType": "PropertyFormatPage", "schema": [ { "name": "items", "kind": "optional", "type": "array", "readOnly": true, "description": "The items in this paged collection.", "modelRef": "#/components/schemas/PropertyFormat", "customType": "PropertyFormat[]", "schema": [ { "name": "key", "kind": "optional", "type": "string", "description": "

The unique identifier (key) of the resource.

", "minLength": 2, "maxLength": 255, "pattern": "^[A-Za-z][_0-9A-Za-z]+$" }, { "name": "dataType", "kind": "optional", "type": "string", "description": "The underlying data type used for this property format.", "example": "string", "examples": [ { "value": "string" }, { "value": "url" }, { "value": "boolean" }, { "value": "integer" }, { "value": "float" }, { "value": "dateTime" }, { "value": "contentReference" }, { "value": "content" }, { "value": "link" }, { "value": "richText" }, { "value": "json" }, { "value": "array" }, { "value": "component" }, { "value": "composition" } ] }, { "name": "itemType", "kind": "optional", "type": "string", "readOnly": true, "description": "The underlying item type used for this property format. Specifies the item type when the dataType is 'array'.", "example": "string", "examples": [ { "value": "string" }, { "value": "url" }, { "value": "boolean" }, { "value": "integer" }, { "value": "float" }, { "value": "dateTime" }, { "value": "contentReference" }, { "value": "content" }, { "value": "link" }, { "value": "richText" }, { "value": "json" }, { "value": "array" }, { "value": "component" }, { "value": "composition" } ] }, { "name": "displayName", "kind": "optional", "type": "string", "description": "The display name of this property format." }, { "name": "isDeleted", "kind": "optional", "type": "boolean", "readOnly": true, "description": "Indicates if this property format has been deleted." }, { "name": "created", "kind": "optional", "type": "string", "readOnly": true, "description": "A timestamp indicating when this display template was first created.", "format": "date-time" }, { "name": "createdBy", "kind": "optional", "type": "string", "readOnly": true, "description": "The username of the user that created this display template." }, { "name": "lastModified", "kind": "optional", "type": "string", "readOnly": true, "description": "A timestamp indicating when this display template was last modified.", "format": "date-time" }, { "name": "lastModifiedBy", "kind": "optional", "type": "string", "readOnly": true, "description": "The username of the user that last modified this display template." } ] }, { "name": "pageIndex", "kind": "optional", "type": "integer", "readOnly": true, "description": "

The zero-based index of the current page.

", "format": "int32" }, { "name": "pageSize", "kind": "optional", "type": "integer", "readOnly": true, "description": "The number of items in each page. Not necessarily the same as the number of items in this page.", "format": "int32" }, { "name": "totalCount", "kind": "optional", "type": "integer", "readOnly": true, "nullable": true, "description": "The estimated total number of items in the collection. May be omitted if the total count is unknown.", "format": "int32" } ], "modelRef": "#/components/schemas/PropertyFormatPage", "isExpanded": true } ] }, { "statusCode": "401", "description": "Unauthorized", "jsonExample": "", "isExpanded": true }, { "statusCode": "403", "description": "Forbidden", "jsonExample": "", "isExpanded": true }, { "statusCode": "429", "description": "Too Many Requests", "jsonExample": "", "isExpanded": true, "headers": [ { "kind": "optional", "name": "Retry-After", "type": "number", "description": "Indicates how long the client should wait before making a new request." } ], "schema": [ { "kind": "optional", "type": "object", "description": "", "customType": "ProblemDetails", "schema": [ { "name": "type", "kind": "optional", "type": "string", "nullable": true, "description": "A URI reference that identifies the problem type.", "format": "uri" }, { "name": "title", "kind": "optional", "type": "string", "nullable": true, "description": "

A short, human-readable summary of the problem type.

" }, { "name": "status", "kind": "optional", "type": "integer", "nullable": true, "description": "The HTTP status code generated by the origin server for this occurrence of the problem.", "format": "int32", "minimum": 100, "maximum": 599 }, { "name": "detail", "kind": "optional", "type": "string", "nullable": true, "description": "

A human-readable explanation specific to this occurrence of the problem.

" }, { "name": "instance", "kind": "optional", "type": "string", "nullable": true, "description": "A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.", "format": "uri" }, { "name": "code", "kind": "optional", "type": "string", "nullable": true, "description": "Error code that identifies the problem type." }, { "name": "errors", "kind": "optional", "type": "array", "nullable": true, "description": "An array of error details with more detailed information about the problem.", "example": "", "itemType": "object", "customType": "object[]", "schema": [ { "name": "detail", "kind": "optional", "type": "string", "description": "

A granular explanation of one specific error related to a field, header or query parameter.

" }, { "name": "field", "kind": "optional", "type": "string", "nullable": true, "description": "A string that may provide a hint to which field that was the source of the error.", "example": "properties.header.displayName" } ] } ], "modelRef": "#/components/schemas/ProblemDetails", "isExpanded": true } ] }, { "statusCode": "500", "description": "Internal Server Error", "jsonExample": "", "isExpanded": true } ], "hasXCodeSamples": false, "examples": { "languages": [ { "id": "RHACxgiz75yCIOxcppZUy", "language": "curl", "label": "cURL", "code": "curl --request GET \\\n --url https://api.cms.optimizely.com/v1/propertyformats \\\n --header 'accept: application/json'" }, { "id": "1IAwAzm_eo803Z4ty326H", "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.cms.optimizely.com/v1/propertyformats\", requestOptions)\n .then(response => response.text())\n .then(result => console.log(result))\n .catch(error => console.log('error', error));" }, { "id": "zvH8gwhRoDAoScwvFu0bK", "language": "ruby", "label": "Ruby", "code": "require \"uri\"\nrequire \"json\"\nrequire \"net/http\"\n\nurl = URI(\"https://api.cms.optimizely.com/v1/propertyformats\")\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": "5DkaWpHG22_N2kCgLArC8", "language": "python", "label": "Python", "code": "import requests\nimport json\n\nurl = \"https://api.cms.optimizely.com/v1/propertyformats\"\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": "RHACxgiz75yCIOxcppZUy" }, "results": { "languages": [ { "id": "response-0-200", "language": "200", "code": "// OK\n{\n \"items\": [\n {\n \"key\": \"\",\n \"dataType\": \"string\",\n \"itemType\": \"string\",\n \"displayName\": \"\",\n \"isDeleted\": false,\n \"created\": \"\",\n \"createdBy\": \"\",\n \"lastModified\": \"\",\n \"lastModifiedBy\": \"\"\n }\n ],\n \"pageIndex\": \"\",\n \"pageSize\": \"\",\n \"totalCount\": \"\"\n}" }, { "id": "response-1-401", "language": "401", "code": "// Unauthorized\n" }, { "id": "response-2-403", "language": "403", "code": "// Forbidden\n" }, { "id": "response-3-429", "language": "429", "code": "// Too Many Requests\n{\n \"type\": \"\",\n \"title\": \"\",\n \"status\": \"\",\n \"detail\": \"\",\n \"instance\": \"\",\n \"code\": \"\",\n \"errors\": [\n {\n \"detail\": \"\",\n \"field\": \"properties.header.displayName\"\n }\n ]\n}" }, { "id": "response-4-500", "language": "500", "code": "// Internal Server Error\n" } ], "selectedLanguageId": "response-0-200" } }, "children": [ { "text": "" } ] }