--- title: Find invite by external id slug: find-invite-by-external-id docTags: createdAt: 2023-04-12T08:32:15.000Z --- :::ApiMethodV2 ```json { "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" } ``` :::