Invites
Find invite by email
1 min
{ "tab" "examples", "url" "https //api brella io/api/integration/organizations/{organizationid}/events/{eventid}/invites/find/?external email={emailaddress}", "name" "find invite by email", "method" "get", "request" { "pathparameters" \[ { "kind" "required", "name" "{organizationid}", "type" "number", "children" \[], "description" "the id of the brella organization you are trying to retrieve data from" }, { "kind" "required", "name" "{eventid}", "type" "number", "children" \[], "description" "the id of the brella event you are trying to retrieve data from" } ], "queryparameters" \[ { "kind" "required", "name" "external email", "type" "string", "children" \[], "description" "the email address associated with the invite emails are not unique in brella, as there can be multiple invites for the same email address " } ], "headerparameters" \[ { "kind" "required", "name" "brella api access token", "type" "string", "children" \[], "description" "your unique brella api key" }, { "kind" "required", "name" "accept", "type" "string", "children" \[], "description" "application/vnd brella v4+json" }, { "kind" "required", "name" "content type", "type" "string", "children" \[], "description" "application/json" } ], "bodydataparameters" \[], "formdataparameters" \[] }, "results" { "languages" \[ { "id" "psobomoj9uo00ibrqhmgp", "code" "{\n \\"data\\" {\n \\"id\\" \\"712426\\",\n \\"type\\" \\"invite\\",\n \\"attributes\\" {\n \\"fill token\\" \\"htsqiu\\",\n \\"external email\\" \\"testing+invites3075\@example com\\",\n \\"external id\\" \\"ab13075\\",\n \\"external first name\\" \\"john\\",\n \\"external last name\\" \\"mctestersson\\",\n \\"external company\\" \\"testers 3075\\",\n \\"external title\\" \\"qa \\",\n \\"qr string\\" \\"brella invite id=712426\&brella invite token=htsqiu\\",\n \\"created at\\" \\"2023 01 24t20 03 26 637z\\",\n \\"updated at\\" \\"2023 01 29t18 21 23 759z\\",\n \\"attendee group name\\" \\"attendees\\",\n \\"seat count\\" \\"5\\",\n \\"free seat count\\" \\"5\\"\n },\n \\"relationships\\" {\n \\"attendee group\\" {\n \\"data\\" {\n \\"id\\" \\"11428\\",\n \\"type\\" \\"attendee group\\"\n }\n },\n \\"seats\\" {\n \\"data\\" \[\n {\n \\"id\\" \\"3583608\\",\n \\"type\\" \\"seat\\"\n },\n {\n \\"id\\" \\"3583607\\",\n \\"type\\" \\"seat\\"\n },\n {\n \\"id\\" \\"3583606\\",\n \\"type\\" \\"seat\\"\n },\n {\n \\"id\\" \\"3583605\\",\n \\"type\\" \\"seat\\"\n },\n {\n \\"id\\" \\"3583604\\",\n \\"type\\" \\"seat\\"\n }\n ]\n },\n \\"free seats\\" {\n \\"data\\" \[\n {\n \\"id\\" \\"3583608\\",\n \\"type\\" \\"seat\\"\n },\n {\n \\"id\\" \\"3583607\\",\n \\"type\\" \\"seat\\"\n },\n {\n \\"id\\" \\"3583606\\",\n \\"type\\" \\"seat\\"\n },\n {\n \\"id\\" \\"3583605\\",\n \\"type\\" \\"seat\\"\n },\n {\n \\"id\\" \\"3583604\\",\n \\"type\\" \\"seat\\"\n }\n ]\n },\n \\"question responses\\" {\n \\"data\\" \[]\n }\n }\n },\n \\"included\\" \[\n {\n \\"id\\" \\"3583608\\",\n \\"type\\" \\"seat\\",\n \\"attributes\\" {\n \\"token\\" \\"htsqiu\\"\n },\n \\"relationships\\" {\n \\"attendee\\" {\n \\"data\\" {}\n }\n }\n },\n {\n \\"id\\" \\"3583607\\",\n \\"type\\" \\"seat\\",\n \\"attributes\\" {\n \\"token\\" \\"htsqiu\\"\n },\n \\"relationships\\" {\n \\"attendee\\" {\n \\"data\\" {}\n }\n }\n },\n {\n \\"id\\" \\"3583606\\",\n \\"type\\" \\"seat\\",\n \\"attributes\\" {\n \\"token\\" \\"htsqiu\\"\n },\n \\"relationships\\" {\n \\"attendee\\" {\n \\"data\\" {}\n }\n }\n },\n {\n \\"id\\" \\"3583605\\",\n \\"type\\" \\"seat\\",\n \\"attributes\\" {\n \\"token\\" \\"htsqiu\\"\n },\n \\"relationships\\" {\n \\"attendee\\" {\n \\"data\\" {}\n }\n }\n },\n {\n \\"id\\" \\"3583604\\",\n \\"type\\" \\"seat\\",\n \\"attributes\\" {\n \\"token\\" \\"htsqiu\\"\n },\n \\"relationships\\" {\n \\"attendee\\" {\n \\"data\\" {}\n }\n }\n },\n {\n \\"id\\" \\"11428\\",\n \\"type\\" \\"attendee group\\",\n \\"attributes\\" {\n \\"name\\" \\"attendees\\",\n \\"attendance type\\" \\"virtual\\",\n \\"default\\" \\"true\\",\n \\"users are deletable\\" \\"false\\",\n \\"created at\\" \\"2022 04 13t11 18 36 831z\\",\n \\"updated at\\" \\"2022 04 13t11 18 36 831z\\",\n \\"attendees count\\" {}\n },\n \\"relationships\\" {\n \\"attendees\\" {\n \\"data\\" \[]\n }\n }\n }\n ]\n}", "language" "200", "customlabel" "" } ], "selectedlanguageid" "psobomoj9uo00ibrqhmgp" }, "examples" { "languages" \[ { "id" "f3c6omtiin7l8ffnpjuuk", "code" "curl location g request get 'https //api brella io/api/integration/organizations/{organizationid}/events/{eventid}/invites/find/?external email={emailaddress}' \\\\\n header 'brella api access token string' \\\\\n header 'accept application/vnd brella v4+json' \\\\\n header 'content type application/json'", "language" "curl", "customlabel" "" } ], "selectedlanguageid" "f3c6omtiin7l8ffnpjuuk" }, "description" "find an invite (or many invites) by searching for them by the associated email address", "currentnewparameter" { "label" "query parameter", "value" "queryparameters" } }