Journey Docs
Partner API ExplorerVguests

List invites across your reach

Required scopespartner:guests:readandpartner:guests:pii:read
GET
/v1/partner/vguests/guest-invites/all

Every invitation for the brands and venues the credential can reach. Filters narrow that reach and can never widen it: ids outside your reach are dropped, and a filter that leaves nothing returns an empty list. Requires both partner:guests:read (declared on the controller) and partner:guests:pii:read (on the handler) — the guard ANDs them.

Authorization

headerAuthorizationBearer <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.

Query Parameters

brandIds?array<string>

Comma-separated internal numeric brand ids to narrow to. Ids outside your reach are ignored.

venueIds?array<string>

Comma-separated internal numeric venue (property) ids to narrow to. Ids outside your reach are ignored.

Response Body

Invitations within reach.

application/json
  1. response
[index: integer]?
curl -X GET 'https://api-prd.cf.journey.com/v1/partner/vguests/guest-invites/all'
[  {    "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  }]