sitecore Guests API
Endpoints for creating, retrieving, updating, and deleting guest profiles in Sitecore CDP. Guests represent the core customer entity storing personal, behavioral, and transactional data.
sitecore Guests 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 Guests. 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 5 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.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
sitecore Guests 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.
Endpoints for creating, retrieving, updating, and deleting guest profiles in Sitecore CDP. Guests represent the core customer entity storing personal, behavioral, and transactiona…
Schemas 5
The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Guest (10 properties), CreateGuestRequest (6 properties), GuestListResponse (4 properties), GuestIdentifier (3 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Sitecore 12
Other APIs Sitecore publishes across the network.
This is an independent, third-party profile of sitecore Guests 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.