Get experience by ID with personalization input | Documentation

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 '{
  "extensions": {
    "personalization": {
      "profileId": "profile_9xZv2QwPmR"
    }
  },
  "parameters": {
    "featuredPosts": {
      "limit": 6,
      "order": "-fields.title"
    },
    "item": {
      "fields": {
        "slug": "standing-desk"
      }
    }
  }
}'

{
  "errors": [],
  "extensions": {
    "personalization": {
      "changes": [
        {
          "id": "4RqKkGJqLHpMiomHuILv5N",
          "meta": {
            "optimizationId": "optim_Yw8rFzNpSe",
            "variantIndex": 1
          },
          "type": "Experience",
          "variantId": "variant_returning"
        }
      ],
      "experiences": [
        {
          "experienceId": "4RqKkGJqLHpMiomHuILv5N",
          "variantIndex": 1,
          "variants": {
            "variant_returning": "Experience:4RqKkGJqLHpMiomHuILv5N:1b414538-5894-483a-9441-2cbfa65a0aab"
          }
        }
      ],
      "profile": {
        "audiences": [
          "returning-visitor",
          "high-intent"
        ],
        "id": "profile_9xZv2QwPmR",
        "location": {
          "city": "San Francisco",
          "continent": "North America",
          "coordinates": {
            "latitude": 37.7749,
            "longitude": -122.4194
          },
          "country": "United States",
          "countryCode": "US",
          "postalCode": "94105",
          "region": "California",
          "regionCode": "CA",
          "timezone": "America/Los_Angeles"
        },
        "random": 0.7241,
        "session": {
          "activeSessionLength": 312,
          "averageSessionLength": 247,
          "count": 4,
          "id": "sess_Lm7nBvCqZa",
          "isReturningVisitor": true,
          "landingPage": {
            "path": "/pricing",
            "query": {},
            "referrer": "https://www.google.com/",
            "search": "",
            "url": "https://www.contentful.com/pricing"
          }
        },
        "stableId": "stable_Kn3jDpXqTy",
        "traits": {
          "industry": "technology",
          "planTier": "pro"
        }
      }
    }
  },
  "nodes": [
    {
      "component": {
        "sys": {
          "linkType": "Contentful:Component",
          "type": "ResourceLink",
          "urn": "crn:contentful:::experience:spaces/f8bqpb154z5p/environments/master/components/heroSection"
        }
      },
      "contentProperties": {
        "backgroundImage": {
          "sys": {
            "id": "7xPKmNzaRQsVf2DJeUoBcL",
            "linkType": "Asset",
            "type": "Link"
          }
        },
        "ctaLabel": "Explore now",
        "ctaUrl": "https://www.contentful.com/explore/",
        "heading": "Experience designed for you",
        "subheading": "Personalized to match your interests."
      },
      "designProperties": {
        "backgroundColor": {
          "type": "DesignToken",
          "value": "color.brand.accent"
        },
        "paddingBottom": {
          "type": "ManualDesignValue",
          "value": "80px"
        },
        "paddingTop": {
          "type": "ManualDesignValue",
          "value": "80px"
        },
        "textAlign": {
          "type": "ManualDesignValue",
          "value": "center"
        }
      },
      "id": "node_a1b2c3d4",
      "slots": {}
    },
    {
      "component": {
        "sys": {
          "linkType": "Contentful:Component",
          "type": "ResourceLink",
          "urn": "crn:contentful:::experience:spaces/f8bqpb154z5p/environments/master/components/contentBanner"
        }
      },
      "contentProperties": {
        "badgeText": "Exclusive",
        "body": "You've been here before — here's 20% off your first project.",
        "title": "Special offer for returning visitors"
      },
      "designProperties": {
        "backgroundColor": {
          "type": "DesignToken",
          "value": "color.surface.highlight"
        },
        "borderRadius": {
          "type": "DesignToken",
          "value": "radius.md"
        },
        "visible": {
          "type": "ManualDesignValue",
          "value": true
        }
      },
      "id": "node_i9j0k1l2",
      "slots": {}
    }
  ],
  "sys": {
    "createdAt": "2024-11-12T09:00:00.000Z",
    "createdBy": {
      "sys": {
        "id": "5Yd2oeWy3aJq8DPv1NRFKE",
        "linkType": "User",
        "type": "Link"
      }
    },
    "environment": {
      "sys": {
        "id": "master",
        "linkType": "Environment",
        "type": "Link"
      }
    },
    "experienceTemplate": {
      "sys": {
        "linkType": "Contentful:ExperienceTemplate",
        "type": "ResourceLink",
        "urn": "crn:contentful:::experience:spaces/f8bqpb154z5p/environments/master/experienceTemplates/landingPageTemplate"
      }
    },
    "firstPublishedAt": "2024-11-12T09:05:00.000Z",
    "id": "4RqKkGJqLHpMiomHuILv5N",
    "localeStatus": {
      "en-US": "published"
    },
    "publishedAt": "2025-03-18T14:35:00.000Z",
    "publishedBy": {
      "sys": {
        "id": "5Yd2oeWy3aJq8DPv1NRFKE",
        "linkType": "User",
        "type": "Link"
      }
    },
    "publishedVersion": 7,
    "space": {
      "sys": {
        "id": "f8bqpb154z5p",
        "linkType": "Space",
        "type": "Link"
      }
    },
    "type": "Experience",
    "updatedAt": "2025-03-18T14:30:00.000Z",
    "updatedBy": {
      "sys": {
        "id": "5Yd2oeWy3aJq8DPv1NRFKE",
        "linkType": "User",
        "type": "Link"
      }
    }
  }
}

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

If the experience declares parameters, pass their values in parameters, keyed by parameter ID. See Passing parameters to an experience.

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

parametersmap from strings to strings or doubles or objects or maps from strings to strings or doublesOptional

Values for the parameters the experience declares, keyed by parameter ID. See Passing parameters to an experience.

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