Guests: Get single guest with the ID

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.

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"
}