All Invitations for Member
GET/client/users/:correlation_id/household/invites
This API is to Get all the invitations sent by a member (using the correlationId).
Request
Body
This request does not have a body.
Path Variables
correlationId
Response
Returns an array of invitations sent by a member (inviter). A single invitation sent includes the details below.
| Attribute | Definition | Format | Notes |
|---|---|---|---|
| accountID | Inviter's AccountID | String | Required |
| firstName | Inviter's firstName | String | Optional |
| lastName | Inviter's lastName | String | Optional |
| loyaltyID | Inviter's LoyaltyID | String | Required |
| household | Household ID | String | Required |
| householdRole | Inviter household role | Enum "PRIMARY" or "SECONDARY" | Required |
Request
Responses
- 200
200 - Get All Invitations