Get experience by ID with personalization input

POST

https://xdn.contentful.com/spaces/:spaceId/environments/:environmentId/experiences/:id

POST

/spaces/:spaceId/environments/:environmentId/experiences/:id

$ curl -X POST https://xdn.contentful.com/spaces/spaceId/environments/environmentId/experiences/id \
>      -H "cf-environment-uuid: cf-environment-uuid" \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

1 {
2   "errors": [],
3   "extensions": {
4     "personalization": {
5       "changes": [
6         {
7           "id": "4RqKkGJqLHpMiomHuILv5N",
8           "meta": {
9             "optimizationId": "optim_Yw8rFzNpSe",
10             "variantIndex": 1
11           },
12           "type": "Experience",
13           "variantId": "variant_returning"
14         }
15       ],
16       "experiences": [
17         {
18           "experienceId": "4RqKkGJqLHpMiomHuILv5N",
19           "variantIndex": 1,
20           "variants": {
21             "variant_returning": "Experience:4RqKkGJqLHpMiomHuILv5N:1b414538-5894-483a-9441-2cbfa65a0aab"
22           }
23         }
24       ],
25       "profile": {
26         "audiences": [
27           "returning-visitor",
28           "high-intent"
29         ],
30         "id": "profile_9xZv2QwPmR",
31         "location": {
32           "city": "San Francisco",
33           "continent": "North America",
34           "coordinates": {
35             "latitude": 37.7749,
36             "longitude": -122.4194
37           },
38           "country": "United States",
39           "countryCode": "US",
40           "postalCode": "94105",
41           "region": "California",
42           "regionCode": "CA",
43           "timezone": "America/Los_Angeles"
44         },
45         "random": 0.7241,
46         "session": {
47           "activeSessionLength": 312,
48           "averageSessionLength": 247,
49           "count": 4,
50           "id": "sess_Lm7nBvCqZa",
51           "isReturningVisitor": true,
52           "landingPage": {
53             "path": "/pricing",
54             "query": {},
55             "referrer": "https://www.google.com/",
56             "search": "",
57             "url": "https://www.contentful.com/pricing"
58           }
59         },
60         "stableId": "stable_Kn3jDpXqTy",
61         "traits": {
62           "industry": "technology",
63           "planTier": "pro"
64         }
65       }
66     }
67   },
68   "nodes": [
69     {
70       "component": {
71         "sys": {
72           "linkType": "Contentful:Component",
73           "type": "ResourceLink",
74           "urn": "crn:contentful:::experience:spaces/f8bqpb154z5p/environments/master/components/heroSection"
75         }
76       },
77       "contentProperties": {
78         "backgroundImage": {
79           "sys": {
80             "id": "7xPKmNzaRQsVf2DJeUoBcL",
81             "linkType": "Asset",
82             "type": "Link"
83           }
84         },
85         "ctaLabel": "Explore now",
86         "ctaUrl": "https://www.contentful.com/explore/",
87         "heading": "Experience designed for you",
88         "subheading": "Personalized to match your interests."
89       },
90       "designProperties": {
91         "backgroundColor": {
92           "type": "DesignToken",
93           "value": "color.brand.accent"
94         },
95         "paddingBottom": {
96           "type": "ManualDesignValue",
97           "value": "80px"
98         },
99         "paddingTop": {
100           "type": "ManualDesignValue",
101           "value": "80px"
102         },
103         "textAlign": {
104           "type": "ManualDesignValue",
105           "value": "center"
106         }
107       },
108       "id": "node_a1b2c3d4",
109       "slots": {}
110     },
111     {
112       "component": {
113         "sys": {
114           "linkType": "Contentful:Component",
115           "type": "ResourceLink",
116           "urn": "crn:contentful:::experience:spaces/f8bqpb154z5p/environments/master/components/contentBanner"
117         }
118       },
119       "contentProperties": {
120         "badgeText": "Exclusive",
121         "body": "You've been here before — here's 20% off your first project.",
122         "title": "Special offer for returning visitors"
123       },
124       "designProperties": {
125         "backgroundColor": {
126           "type": "DesignToken",
127           "value": "color.surface.highlight"
128         },
129         "borderRadius": {
130           "type": "DesignToken",
131           "value": "radius.md"
132         },
133         "visible": {
134           "type": "ManualDesignValue",
135           "value": true
136         }
137       },
138       "id": "node_i9j0k1l2",
139       "slots": {}
140     }
141   ],
142   "sys": {
143     "createdAt": "2024-11-12T09:00:00.000Z",
144     "createdBy": {
145       "sys": {
146         "id": "5Yd2oeWy3aJq8DPv1NRFKE",
147         "linkType": "User",
148         "type": "Link"
149       }
150     },
151     "environment": {
152       "sys": {
153         "id": "master",
154         "linkType": "Environment",
155         "type": "Link"
156       }
157     },
158     "experienceTemplate": {
159       "sys": {
160         "linkType": "Contentful:ExperienceTemplate",
161         "type": "ResourceLink",
162         "urn": "crn:contentful:::experience:spaces/f8bqpb154z5p/environments/master/experienceTemplates/landingPageTemplate"
163       }
164     },
165     "firstPublishedAt": "2024-11-12T09:05:00.000Z",
166     "id": "4RqKkGJqLHpMiomHuILv5N",
167     "localeStatus": {
168       "en-US": "published"
169     },
170     "publishedAt": "2025-03-18T14:35:00.000Z",
171     "publishedBy": {
172       "sys": {
173         "id": "5Yd2oeWy3aJq8DPv1NRFKE",
174         "linkType": "User",
175         "type": "Link"
176       }
177     },
178     "publishedVersion": 7,
179     "space": {
180       "sys": {
181         "id": "f8bqpb154z5p",
182         "linkType": "Space",
183         "type": "Link"
184       }
185     },
186     "type": "Experience",
187     "updatedAt": "2025-03-18T14:30:00.000Z",
188     "updatedBy": {
189       "sys": {
190         "id": "5Yd2oeWy3aJq8DPv1NRFKE",
191         "linkType": "User",
192         "type": "Link"
193       }
194     }
195   },
196   "viewports": []
197 }

Returns a hydrated experience by ID, applying personalization input from the request body.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

spaceIdstringRequired

environmentIdstringRequired

idstringRequired

Query parameters

access_tokenstringOptional

optimization-profile-idstringOptional

localestringOptional

previewanyOptional

variantstringOptional

Request

Body

extensionsobjectOptional

Response

200

object

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

500

Internal Server Error