Get a Member's Household Invites

Request Details

Item	Value
Description	Returns a member’s household invites.
Method	GET
Endpoint	https://[environment]api[client_id].crowdtwist.com/v2/users/[user_id]/household_invitations?api_key=[api_key]

Request

Field Name	Sample Value	Required	Format	Notes
URL PARAMETERS
user_id	238901577	Yes	Integer
QUERY STRING PARAMETERS
api_key	QWERTYUIOP	Yes	String

Successful Response

Field Name	Sample Value	Format	Description
invitation_id	12	Integer	The id of this invitation.
household_id	8	Integer	The id of this household.
email_address	"jack@example.com"	String	The email address of the invitee.
date_sent	"2020-11-25T19:27:42.000Z"	String (ISO 8601)	The date this invitation was sent.
status	"PENDING"	String	The status of this invitation. Status will be one of the following: "ACCEPTED", "REJECTED", "PENDING", "REMOVED"

Sample Successful Response

[
    {
        "invitation_id": 12,
        "household_id": 8,
        "email_address": "jack@example.com",
        "date_sent": "2020-11-25T19:27:42.000Z",
        "status": "PENDING"
    }
]

Error Responses

Error Code	Description
404	Unable to find household invitations for member.