To retrieve data about a single guest, you need the unique guest ID, which can be found through various methods and is included in the data from the "all guests" request. The request method is GET, using the URL `https://global.stampede.ai/v1/guests/*guest_id*`, with authentication via a Bearer token. The `guest_id` is a required string parameter in the query. The response includes detailed guest information such as organisation ID, profile ID, and user profile details. If the guest record is not found, a JSON message "Not Found" is returned. An example URL with a sample guest ID is provided for reference.
It is possible to retrieve all data about a single guest if the unique guest ID is known. This can be found in a number of ways and is also listed in the data returned by the all guests request.
Request
Method: GET
URL: https://global.stampede.ai/v1/guests/*guest_id*
Auth: Bearer token
The following values may be sent as query parameters.
| Name | Type | Required | Description |
|---|---|---|---|
| guest_id | String | Yes | The unique ID of the guest |
Response
{
id: string;
organization_id: string;
profile_id: number;
last_interacted_at: string;
created_at: string;
data_opt_in_at: string | null;
sms_opt_in_at: string | null;
email_opt_in_at: string;
user_profile: {
email: string;
id: number;
verified: number;
first: string | null;
last: string | null;
phone: string | null;
lat: number | null;
lng: number | null;
birth_day: number | null;
birth_month: number | null;
postcode: string | null;
country: string | null;
gender: string | null;
};
organization_registration_personalisation_choice: any[];
custom_question_answers: any[];
}
Examples
To retrieve the data about the guest, we use the Stampede guest ID. This is a GUID that is passed as part of the request. The example below uses the guest ID of c25502f3-xxxx-xxxx-a736-27be8f5d46e5
https://global.stampede.ai/v1/guests/c25502f3-xxxx-xxxx-a736-27be8f5d46e5
If the guest record is not found then the message below is returned via JSON:
{
"message": "Not Found"
}