Find invite by external id
1 min
{ "tab" "examples", "url" "https //api brella io/api/integration/organizations/{organizationid}/events/{eventid}/invites/find/?external id={externalid}", "name" "find invite by external id", "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 id", "type" "string", "children" \[], "description" "the external id is a custom field used to store, for example, uuids from 3rd party systems that are being integrated with brella this field is only editable and accessible through the api and csv imports it is not generated by default " } ], "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", "language" "200", "code" "\[\n {\n \\"data\\" {\n \\"id\\" \\"12017635\\",\n \\"type\\" \\"invite\\",\n \\"attributes\\" {\n \\"fill token\\" \\"gpqa0m\\",\n \\"external email\\" \\"test+invites\@brella io\\",\n \\"external id\\" \\"123test456\\",\n \\"external first name\\" \\"test\\",\n \\"external last name\\" \\"invites\\",\n \\"external company\\" \\"brella\\",\n \\"external title\\" \\"test event\\",\n \\"qr string\\" \\"brella invite id=12017635\&brella invite token=gpqa0m\\",\n \\"created at\\" \\"2026 07 06t07 50 36 437z\\",\n \\"updated at\\" \\"2026 07 06t08 01 05 285z\\",\n \\"ticket type list name\\" \\"sponsors (in person)\\",\n \\"seat count\\" 1,\n \\"free seat count\\" 1\n },\n \\"relationships\\" {\n \\"event\\" {\n \\"data\\" {\n \\"id\\" \\"8318\\",\n \\"type\\" \\"event\\"\n }\n },\n \\"ticket type list\\" {\n \\"data\\" {\n \\"id\\" \\"68637\\",\n \\"type\\" \\"registrant list\\"\n }\n },\n \\"ticket purchase\\" {\n \\"data\\" {\n \\"id\\" \\"53510cdf e095 4896 8842 7fa4beef160b\\",\n \\"type\\" \\"ticket purchase\\"\n }\n },\n \\"persona\\" {\n \\"data\\" {\n \\"id\\" \\"5056\\",\n \\"type\\" \\"persona\\"\n }\n },\n \\"function\\" {\n \\"data\\" {\n \\"id\\" \\"6891\\",\n \\"type\\" \\"function\\"\n }\n },\n \\"industry\\" {\n \\"data\\" {\n \\"id\\" \\"8945\\",\n \\"type\\" \\"industry\\"\n }\n },\n \\"seats\\" {\n \\"data\\" \[\n {\n \\"id\\" \\"12651467\\",\n \\"type\\" \\"seat\\"\n }\n ]\n },\n \\"free seats\\" {\n \\"data\\" \[\n {\n \\"id\\" \\"12651467\\",\n \\"type\\" \\"seat\\"\n }\n ]\n },\n \\"question responses\\" {\n \\"data\\" \[]\n },\n \\"custom fields\\" {\n \\"data\\" \[\n {\n \\"id\\" \\"3900419\\",\n \\"type\\" \\"custom field\\"\n },\n {\n \\"id\\" \\"3900420\\",\n \\"type\\" \\"custom field\\"\n }\n ]\n },\n \\"selected interests\\" {\n \\"data\\" \[\n {\n \\"id\\" \\"50666856\\",\n \\"type\\" \\"selected interest\\"\n },\n {\n \\"id\\" \\"50666857\\",\n \\"type\\" \\"selected interest\\"\n },\n {\n \\"id\\" \\"50666858\\",\n \\"type\\" \\"selected interest\\"\n },\n {\n \\"id\\" \\"50666859\\",\n \\"type\\" \\"selected interest\\"\n },\n {\n \\"id\\" \\"50666860\\",\n \\"type\\" \\"selected interest\\"\n },\n {\n \\"id\\" \\"50666861\\",\n \\"type\\" \\"selected interest\\"\n },\n {\n \\"id\\" \\"50666862\\",\n \\"type\\" \\"selected interest\\"\n }\n ]\n }\n }\n },\n \\"included\\" \[\n {\n \\"id\\" \\"12651467\\",\n \\"type\\" \\"seat\\",\n \\"attributes\\" {\n \\"token\\" \\"gpqa0m\\"\n },\n \\"relationships\\" {\n \\"attendee\\" {\n \\"data\\" null\n }\n }\n },\n {\n \\"id\\" \\"68637\\",\n \\"type\\" \\"registrant list\\",\n \\"attributes\\" {\n \\"name\\" \\"sponsors (in person)\\",\n \\"description\\" null,\n \\"display name\\" \\"sponsors (in person)\\",\n \\"list type\\" \\"ticket type\\",\n \\"attendance type\\" \\"in person\\",\n \\"is default\\" false,\n \\"position\\" null,\n \\"profile badge\\" null,\n \\"networking enabled\\" true,\n \\"lead scanning enabled\\" true,\n \\"qr code visible\\" true,\n \\"meeting requests outgoing\\" null,\n \\"meeting requests incoming\\" null,\n \\"max outgoing meeting requests\\" null,\n \\"max accepted meetings\\" null,\n \\"show invites in apps\\" true,\n \\"show invited registrants\\" true,\n \\"show booking system join url\\" true,\n \\"created at\\" \\"2026 07 04t04 17 21 421z\\",\n \\"updated at\\" \\"2026 07 04t04 17 21 421z\\",\n \\"old group id\\" 23377\n }\n },\n {\n \\"id\\" \\"3900419\\",\n \\"type\\" \\"custom field\\",\n \\"attributes\\" {\n \\"key\\" \\"dinner\\",\n \\"title\\" \\"dinner\\",\n \\"value\\" \\"yes\\",\n \\"values\\" \[\n \\"yes\\"\n ]\n }\n },\n {\n \\"id\\" \\"3900420\\",\n \\"type\\" \\"custom field\\",\n \\"attributes\\" {\n \\"key\\" \\"lunch\\",\n \\"title\\" \\"lunch\\",\n \\"value\\" null,\n \\"values\\" \[]\n }\n },\n {\n \\"id\\" \\"8318\\",\n \\"type\\" \\"event\\",\n \\"attributes\\" {\n \\"id\\" 8318,\n \\"name\\" \\"amy networking event\\",\n \\"location\\" \\"\\",\n \\"address\\" \\"\\",\n \\"start date\\" \\"2026 08 09\\",\n \\"end date\\" \\"2026 08 12\\",\n \\"past\\" false,\n \\"table nickname\\" \\"table\\",\n \\"infoarea photo url\\" null,\n \\"cover photo url\\" \\"https //brella assets brella io/uploads/event/cover photo/8318/a4d3cb6f76783 jpg\\",\n \\"logo large url\\" \\"https //brella assets brella io/uploads/event/logo large/8318/e9a22b36c3704 jpg\\",\n \\"logo small url\\" \\"https //brella assets brella io/uploads/event/logo small/8318/a71f7a10dd4be jpg\\",\n \\"uses interests\\" true,\n \\"uses timeslots\\" true,\n \\"uses tables\\" false,\n \\"uses sponsors\\" true,\n \\"uses speakers\\" true,\n \\"event type\\" \\"hybrid\\",\n \\"uses stream link\\" true,\n \\"uses meeting slots\\" true,\n \\"uses event chat\\" true,\n \\"uses timeslot chat\\" false,\n \\"uses wizard\\" false,\n \\"uses sponsor booth links\\" false,\n \\"uses ticketing\\" false,\n \\"uses checkout\\" true,\n \\"uses invoicing\\" false,\n \\"uses rsvp overlapping\\" true,\n \\"industry\\" \\"artificial intelligence\\",\n \\"city\\" \\"denver\\",\n \\"country\\" \\"united states\\",\n \\"region\\" \\"north america\\",\n \\"created at\\" \\"2024 08 06t09 30 14 514z\\",\n \\"updated at\\" \\"2026 07 06t08 24 28 698z\\",\n \\"content\\" null,\n \\"sponsors name\\" \\"partners\\",\n \\"primary color\\" null,\n \\"secondary color\\" null,\n \\"intent pair ids\\" null,\n \\"uses reception page\\" false,\n \\"launches at\\" null,\n \\"start time utc\\" \\"2026 08 09t06 00 00 000z\\",\n \\"end time utc\\" \\"2026 08 13t05 59 59 999z\\",\n \\"chat channel id\\" \\"event 8318\\",\n \\"slug\\" \\"amynetworkingevent\\",\n \\"time zone\\" \\"america/boise\\"\n },\n \\"relationships\\" {\n \\"tickets\\" {\n \\"data\\" \[]\n },\n \\"registrant lists\\" {\n \\"data\\" \[\n {\n \\"id\\" \\"68635\\",\n \\"type\\" \\"registrant list\\"\n },\n {\n \\"id\\" \\"68634\\",\n \\"type\\" \\"registrant list\\"\n },\n {\n \\"id\\" \\"68633\\",\n \\"type\\" \\"registrant list\\"\n },\n {\n \\"id\\" \\"68638\\",\n \\"type\\" \\"registrant list\\"\n },\n {\n \\"id\\" \\"68637\\",\n \\"type\\" \\"registrant list\\"\n },\n {\n \\"id\\" \\"68636\\",\n \\"type\\" \\"registrant list\\"\n },\n {\n \\"id\\" \\"68639\\",\n \\"type\\" \\"registrant list\\"\n }\n ]\n },\n \\"questions\\" {\n \\"data\\" \[]\n }\n }\n },\n {\n \\"id\\" \\"53510cdf e095 4896 8842 7fa4beef160b\\",\n \\"type\\" \\"ticket purchase\\",\n \\"attributes\\" {\n \\"purchasers email\\" \\"\\",\n \\"first name\\" \\"test\\",\n \\"last name\\" \\"invites\\",\n \\"status\\" \\"completed\\",\n \\"created at\\" \\"2026 07 06t07 50 37 050z\\",\n \\"updated at\\" \\"2026 07 06t07 50 37 199z\\",\n \\"purchase completed at\\" \\"2026 07 06t07 50 37 189z\\",\n \\"purchase type\\" \\"checkout\\",\n \\"purchasers phone\\" null,\n \\"tax id type\\" null,\n \\"tax id\\" null,\n \\"address line1\\" null,\n \\"address line2\\" null,\n \\"address postal code\\" null,\n \\"address city\\" null,\n \\"address state\\" null,\n \\"address country code\\" null,\n \\"stripe session id\\" null,\n \\"stripe error\\" null,\n \\"created from\\" \\"admin panel\\"\n },\n \\"relationships\\" {\n \\"event\\" {\n \\"data\\" {\n \\"id\\" \\"8318\\",\n \\"type\\" \\"event\\"\n }\n }\n }\n },\n {\n \\"id\\" \\"5056\\",\n \\"type\\" \\"persona\\",\n \\"attributes\\" {\n \\"name\\" \\"solution provider\\",\n \\"position\\" 2\n }\n },\n {\n \\"id\\" \\"6891\\",\n \\"type\\" \\"function\\",\n \\"attributes\\" {\n \\"name\\" \\"business strategy / planning\\",\n \\"position\\" 1\n }\n },\n {\n \\"id\\" \\"8945\\",\n \\"type\\" \\"industry\\",\n \\"attributes\\" {\n \\"name\\" \\"technology and software development\\",\n \\"position\\" 1\n }\n },\n {\n \\"id\\" \\"679919\\",\n \\"type\\" \\"interest\\",\n \\"attributes\\" {\n \\"name\\" \\"bookkeeping\\",\n \\"position\\" 16,\n \\"event id\\" 8318\n },\n \\"relationships\\" {\n \\"children\\" {\n \\"data\\" \[]\n },\n \\"intent pairs\\" {\n \\"data\\" \[\n {\n \\"id\\" \\"1\\",\n \\"type\\" \\"intent pair\\"\n },\n {\n \\"id\\" \\"2\\",\n \\"type\\" \\"intent pair\\"\n },\n {\n \\"id\\" \\"4\\",\n \\"type\\" \\"intent pair\\"\n },\n {\n \\"id\\" \\"3\\",\n \\"type\\" \\"intent pair\\"\n }\n ]\n }\n }\n },\n {\n \\"id\\" \\"1\\",\n \\"type\\" \\"intent\\",\n \\"attributes\\" {\n \\"selection label\\" \\"network about this\\",\n \\"match label\\" \\"networker\\",\n \\"statistics label\\" \\"network\\",\n \\"profile label\\" \\"networking about\\",\n \\"position\\" 1\n },\n \\"relationships\\" {\n \\"pair\\" {\n \\"data\\" {\n \\"id\\" \\"1\\",\n \\"type\\" \\"intent\\"\n }\n }\n }\n },\n {\n \\"id\\" \\"50666856\\",\n \\"type\\" \\"selected interest\\",\n \\"relationships\\" {\n \\"selector\\" {\n \\"data\\" {\n \\"id\\" \\"12017635\\",\n \\"type\\" \\"registrant\\"\n }\n },\n \\"interest\\" {\n \\"data\\" {\n \\"id\\" \\"679919\\",\n \\"type\\" \\"interest\\"\n }\n },\n \\"intent\\" {\n \\"data\\" {\n \\"id\\" \\"1\\",\n \\"type\\" \\"intent\\"\n }\n }\n }\n },\n {\n \\"id\\" \\"2\\",\n \\"type\\" \\"intent\\",\n \\"attributes\\" {\n \\"selection label\\" \\"explore or buy\\",\n \\"match label\\" \\"prospect\\",\n \\"statistics label\\" \\"buy/explore\\",\n \\"profile label\\" \\"exploring getting or buying\\",\n \\"position\\" 2\n },\n \\"relationships\\" {\n \\"pair\\" {\n \\"data\\" {\n \\"id\\" \\"3\\",\n \\"type\\" \\"intent\\"\n }\n }\n }\n },\n {\n \\"id\\" \\"50666857\\",\n \\"type\\" \\"selected interest\\",\n \\"relationships\\" {\n \\"selector\\" {\n \\"data\\" {\n \\"id\\" \\"12017635\\",\n \\"type\\" \\"registrant\\"\n }\n },\n \\"interest\\" {\n \\"data\\" {\n \\"id\\" \\"679919\\",\n \\"type\\" \\"interest\\"\n }\n },\n \\"intent\\" {\n \\"data\\" {\n \\"id\\" \\"2\\",\n \\"type\\" \\"intent\\"\n }\n }\n }\n },\n {\n \\"id\\" \\"4\\",\n \\"type\\" \\"intent\\",\n \\"attributes\\" {\n \\"selection label\\" \\"find a job\\",\n \\"match label\\" \\"job seeker\\",\n \\"statistics label\\" \\"get a job\\",\n \\"profile label\\" \\"seeking a job in\\",\n \\"position\\" 4\n },\n \\"relationships\\" {\n \\"pair\\" {\n \\"data\\" {\n \\"id\\" \\"5\\",\n \\"type\\" \\"intent\\"\n }\n }\n }\n },\n {\n \\"id\\" \\"50666858\\",\n \\"type\\" \\"selected interest\\",\n \\"relationships\\" {\n \\"selector\\" {\n \\"data\\" {\n \\"id\\" \\"12017635\\",\n \\"type\\" \\"registrant\\"\n }\n },\n \\"interest\\" {\n \\"data\\" {\n \\"id\\" \\"679919\\",\n \\"type\\" \\"interest\\"\n }\n },\n \\"intent\\" {\n \\"data\\" {\n \\"id\\" \\"4\\",\n \\"type\\" \\"intent\\"\n }\n }\n }\n },\n {\n \\"id\\" \\"6\\",\n \\"type\\" \\"intent\\",\n \\"attributes\\" {\n \\"selection label\\" \\"get investment\\",\n \\"match label\\" \\"investee\\",\n \\"statistics label\\" \\"get investment\\",\n \\"profile label\\" \\"seeking investment for\\",\n \\"position\\" 7\n },\n \\"relationships\\" {\n \\"pair\\" {\n \\"data\\" {\n \\"id\\" \\"7\\",\n \\"type\\" \\"intent\\"\n }\n }\n }\n },\n {\n \\"id\\" \\"50666859\\",\n \\"type\\" \\"selected interest\\",\n \\"relationships\\" {\n \\"selector\\" {\n \\"data\\" {\n \\"id\\" \\"12017635\\",\n \\"type\\" \\"registrant\\"\n }\n },\n \\"interest\\" {\n \\"data\\" {\n \\"id\\" \\"679919\\",\n \\"type\\" \\"interest\\"\n }\n },\n \\"intent\\" {\n \\"data\\" {\n \\"id\\" \\"6\\",\n \\"type\\" \\"intent\\"\n }\n }\n }\n },\n {\n \\"id\\" \\"679924\\",\n \\"type\\" \\"interest\\",\n \\"attributes\\" {\n \\"name\\" \\"policy underwriting\\",\n \\"position\\" 17,\n \\"event id\\" 8318\n },\n \\"relationships\\" {\n \\"children\\" {\n \\"data\\" \[]\n },\n \\"intent pairs\\" {\n \\"data\\" \[\n {\n \\"id\\" \\"1\\",\n \\"type\\" \\"intent pair\\"\n },\n {\n \\"id\\" \\"3\\",\n \\"type\\" \\"intent pair\\"\n }\n ]\n }\n }\n },\n {\n \\"id\\" \\"50666860\\",\n \\"type\\" \\"selected interest\\",\n \\"relationships\\" {\n \\"selector\\" {\n \\"data\\" {\n \\"id\\" \\"12017635\\",\n \\"type\\" \\"registrant\\"\n }\n },\n \\"interest\\" {\n \\"data\\" {\n \\"id\\" \\"679924\\",\n \\"type\\" \\"interest\\"\n }\n },\n \\"intent\\" {\n \\"data\\" {\n \\"id\\" \\"1\\",\n \\"type\\" \\"intent\\"\n }\n }\n }\n },\n {\n \\"id\\" \\"50666861\\",\n \\"type\\" \\"selected interest\\",\n \\"relationships\\" {\n \\"selector\\" {\n \\"data\\" {\n \\"id\\" \\"12017635\\",\n \\"type\\" \\"registrant\\"\n }\n },\n \\"interest\\" {\n \\"data\\" {\n \\"id\\" \\"679924\\",\n \\"type\\" \\"interest\\"\n }\n },\n \\"intent\\" {\n \\"data\\" {\n \\"id\\" \\"4\\",\n \\"type\\" \\"intent\\"\n }\n }\n }\n },\n {\n \\"id\\" \\"679928\\",\n \\"type\\" \\"interest\\",\n \\"attributes\\" {\n \\"name\\" \\"tax accounting\\",\n \\"position\\" 18,\n \\"event id\\" 8318\n },\n \\"relationships\\" {\n \\"children\\" {\n \\"data\\" \[]\n },\n \\"intent pairs\\" {\n \\"data\\" \[\n {\n \\"id\\" \\"1\\",\n \\"type\\" \\"intent pair\\"\n }\n ]\n }\n }\n },\n {\n \\"id\\" \\"50666862\\",\n \\"type\\" \\"selected interest\\",\n \\"relationships\\" {\n \\"selector\\" {\n \\"data\\" {\n \\"id\\" \\"12017635\\",\n \\"type\\" \\"registrant\\"\n }\n },\n \\"interest\\" {\n \\"data\\" {\n \\"id\\" \\"679928\\",\n \\"type\\" \\"interest\\"\n }\n },\n \\"intent\\" {\n \\"data\\" {\n \\"id\\" \\"1\\",\n \\"type\\" \\"intent\\"\n }\n }\n }\n }\n ]\n }\n]", "customlabel" "" } ], "selectedlanguageid" "psobomoj9uo00ibrqhmgp" }, "examples" { "languages" \[ { "id" "ebpzcvuy6gnib k4wy5at", "code" "curl location g request get 'https //api brella io/api/integration/organizations/{organizationid}/events/{eventid}/invites/find/?external id={externalid}' \\\\\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" "ebpzcvuy6gnib k4wy5at" }, "description" "find an invite (or many invites) by searching for them with the external id", "currentnewparameter" { "label" "query parameter", "value" "queryparameters" }, "hastryitout" false, "autogeneratedanchorslug" "find invite by external id", "legacyhash" "gvk1rurk7djuk oa kdbt" }