Partner API ExplorerVguests
List invites for a verified-guest profile
Required scopes
partner:guests:readandpartner:guests:pii:readGET
Every invitation sent for one verified-guest profile. Requires both partner:guests:read (declared on the controller) and partner:guests:pii:read (on the handler) — the guard ANDs them.
header
AuthorizationBearer <token>WorkOS access token (JWT) for a user who is a member of the partner organization. The organization the request is scoped to is taken from the token, not from a header or query parameter.
Only a JWT is accepted in this header. A Journey jny_ API key sent as a bearer token is rejected
with 401 Invalid or expired token; send it in X-API-Key instead.
WorkOS organization API keys are not accepted yet.
vguestProfileId*integerInternal numeric verified-guest profile id — not an external id. A non-integer value is rejected with 400 before the handler runs.
Invitations for that profile.
application/json- response
[index: integer]?curl -X GET 'https://api-prd.cf.journey.com/v1/partner/vguests/guest-invites?vguestProfileId=0'[ { "brandId": 0, "channel": "email", "contactValue": "string", "createdAt": "string", "expiresAt": "string", "externalReservationId": "string", "inviteId": "string", "reservationId": 0, "sentBy": "string", "sourceApp": "string", "status": "string", "venueId": 0, "vguestProfileId": 0 }]