How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

sitecore Guest Data Extensions API

Endpoints for managing custom key-value data extensions attached to guest profiles. Data extensions allow organizations to store additional structured information beyond the standard guest fields.

sitecore Guest Data Extensions API is one of 33 APIs that Sitecore publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Guest Data Extensions. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.

This API exposes 6 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.2.0, at version v2.1.

Requests are made against 4 base URLs: https://api-engage-eu.sitecorecloud.io, https://api-engage-us.sitecorecloud.io, https://api-engage-ap.sitecorecloud.io, https://api-engage-jpe.sitecorecloud.io.

6 operations 2 paths 2 schemas 1 DELETE2 GET1 PATCH1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v2.1
Base URL
https://edge.sitecorecloud.io/api/graphql
Authentication
HTTP Basic
Terms of Service
Resource Areas
1

Authentication & Security 1

sitecore Guest Data Extensions API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic authentication using a client key as the username and an API token as the password. Credentials are obtained from Sitecore CDP Settings API access.

Paths & Operations 6

Across 2 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Guest Data Extensions 6

Endpoints for managing custom key-value data extensions attached to guest profiles. Data extensions allow organizations to store additional structured information beyond the stand…

GET
/v2.1/guests/{guestRef}/extensions
List guest data extensions
listGuestDataExtensions 1 param → 200401404
POST
/v2.1/guests/{guestRef}/extensions
Create a guest data extension
createGuestDataExtension 1 param body → 201400401404
GET
/v2.1/guests/{guestRef}/extensions/{dataExtensionName}
Get a guest data extension
getGuestDataExtension 2 params → 200401404
PUT
/v2.1/guests/{guestRef}/extensions/{dataExtensionName}
Update a guest data extension (full)
updateGuestDataExtension 2 params body → 200400401404
PATCH
/v2.1/guests/{guestRef}/extensions/{dataExtensionName}
Update a guest data extension (partial)
patchGuestDataExtension 2 params body → 200400401404
DELETE
/v2.1/guests/{guestRef}/extensions/{dataExtensionName}
Delete a guest data extension
deleteGuestDataExtension 2 params → 204401404

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are ErrorResponse (3 properties), DataExtension (3 properties). Each schema is shown below with its type and property counts.

DataExtension
object
A named set of custom key-value pairs attached to a guest or order
3 properties
ErrorResponse
object
An error response body
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sitecore-guest-data-extensions-api-openapi.yml Raw ↑

Other APIs Sitecore publishes across the network.

Sitecore XM Cloud GraphQL Delivery API
Sitecore XM Cloud Authoring and Management GraphQL API
Sitecore CDP Stream API
Sitecore CDP Batch API
Sitecore Content Hub Admin API
sitecore Audit API
sitecore Authentication API
sitecore Buyers API
sitecore Collections API
sitecore Connections API
sitecore Decision Models API
sitecore Download Orders API
Where this information came from

This is an independent, third-party profile of sitecore Guest Data Extensions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.