Invites
List all invites
1min
List all invites in a specific event
GET
Request
Path Params
{organizationId}
Number
required
The id of the Brella organization you are trying to retrieve data from
{eventId}
Number
required
The id of the Brella event you are trying to retrieve data from
Query Parameters
page[size]
Number
required
Paginate the response of this endpoint. This is required.
page[number]
Number
required
Retrieve a specific page of results.
created_from
String
optional
Retrieve entries created from this datetime. Provide the date in the format: 2023-05-02T00:00:00.000Z
created_to
String
optional
Retrieve entries created until this datetime. Provide the date in the format: 2023-05-02T00:00:00.000Z
updated_from
String
optional
Retrieve entries updated from this datetime. Provide the date in the format: 2023-05-02T00:00:00.000Z
updated_to
String
optional
Retrieve entries updated until this datetime. Provide the date in the format: 2023-05-02T00:00:00.000Z
Header Parameters
Brella-API-Access-Token
String
required
Your unique Brella API key
Accept
String
required
application/vnd.brella.v4+json
Content-Type
String
required
application/json
Curl
1curl --location -g --request GET 'https://api.brella.io/api/integration/organizations/{organizationId}/events/{eventId}/invites' \
2--header 'Brella-API-Access-Token: String' \
3--header 'Accept: application/vnd.brella.v4+json' \
4--header 'Content-Type: application/json'
Responses
200
1{
2 "data": [
3 {
4 "id": "633630",
5 "type": "invite",
6 "attributes": {
7 "fill-token": "MIN1MI",
8 "external-email": "[email protected]",
9 "external-id": "kd-34rfo0",
10 "external-first-name": "Kav",
11 "external-last-name": "McTestersson",
12 "external-company": "Brella",
13 "external-title": "PM",
14 "qr-string": "brella_invite_id=633630&brella_invite_token=MIN1MI",
15 "created-at": "2022-09-27T12:15:15.396Z",
16 "updated-at": "2023-01-29T18:37:42.293Z",
17 "attendee-group-name": "Attendees",
18 "seat-count": "1",
19 "free-seat-count": "0"
20 },
21 "relationships": {
22 "attendee-group": {
23 "data": {
24 "id": "11428",
25 "type": "attendee-group"
26 }
27 },
28 "seats": {
29 "data": [
30 {
31 "id": "3414488",
32 "type": "seat"
33 }
34 ]
35 },
36 "free-seats": {
37 "data": []
38 },
39 "question-responses": {
40 "data": []
41 }
42 }
43 },
44 {
45 "id": "479045",
46 "type": "invite",
47 "attributes": {
48 "fill-token": "2SVG6A",
49 "external-email": "[email protected]",
50 "external-id": "lj09-909kl",
51 "external-first-name": "Steffi",
52 "external-last-name": "Val",
53 "external-company": "Zod Co.",
54 "external-title": "Tech Support Lead",
55 "qr-string": "brella_invite_id=479045&brella_invite_token=2SVG6A",
56 "created-at": "2022-04-14T08:52:54.432Z",
57 "updated-at": "2023-01-29T18:21:23.942Z",
58 "attendee-group-name": "Attendees",
59 "seat-count": "1",
60 "free-seat-count": "0"
61 },
62 "relationships": {
63 "attendee-group": {
64 "data": {
65 "id": "11428",
66 "type": "attendee-group"
67 }
68 },
69 "seats": {
70 "data": [
71 {
72 "id": "828510",
73 "type": "seat"
74 }
75 ]
76 },
77 "free-seats": {
78 "data": []
79 },
80 "question-responses": {
81 "data": []
82 }
83 }
84 },
85 {
86 "id": "479046",
87 "type": "invite",
88 "attributes": {
89 "fill-token": "7OJ5BA",
90 "external-email": "[email protected]",
91 "external-id": "8kl0-9hjl",
92 "external-first-name": "Wen",
93 "external-last-name": "Lando",
94 "external-company": "Abacus Co.,",
95 "external-title": "CSM",
96 "qr-string": "brella_invite_id=479046&brella_invite_token=7OJ5BA",
97 "created-at": "2022-04-14T08:54:27.165Z",
98 "updated-at": "2023-01-29T18:21:23.919Z",
99 "attendee-group-name": "Attendees",
100 "seat-count": "1",
101 "free-seat-count": "0"
102 },
103 "relationships": {
104 "attendee-group": {
105 "data": {
106 "id": "11428",
107 "type": "attendee-group"
108 }
109 },
110 "seats": {
111 "data": [
112 {
113 "id": "828511",
114 "type": "seat"
115 }
116 ]
117 },
118 "free-seats": {
119 "data": []
120 },
121 "question-responses": {
122 "data": []
123 }
124 }
125 },
126 {
127 "id": "479048",
128 "type": "invite",
129 "attributes": {
130 "fill-token": "NBIRCV",
131 "external-email": "[email protected]",
132 "external-id": "kzkz0-20",
133 "external-first-name": "Ville",
134 "external-last-name": "Jonah-Smith",
135 "external-company": "Brella",
136 "external-title": "Founder/ CSM Lead",
137 "qr-string": "brella_invite_id=479048&brella_invite_token=NBIRCV",
138 "created-at": "2022-04-14T08:56:59.940Z",
139 "updated-at": "2023-01-29T18:21:23.872Z",
140 "attendee-group-name": "Attendees",
141 "seat-count": "1",
142 "free-seat-count": "0"
143 },
144 "relationships": {
145 "attendee-group": {
146 "data": {
147 "id": "11428",
148 "type": "attendee-group"
149 }
150 },
151 "seats": {
152 "data": [
153 {
154 "id": "828513",
155 "type": "seat"
156 }
157 ]
158 },
159 "free-seats": {
160 "data": []
161 },
162 "question-responses": {
163 "data": []
164 }
165 }
166 },
167 {
168 "id": "588999",
169 "type": "invite",
170 "attributes": {
171 "fill-token": "0AGDJW",
172 "external-email": "[email protected]",
173 "external-id": "ma-at930",
174 "external-first-name": "Sophie",
175 "external-last-name": "DiPalo",
176 "external-company": "Brella",
177 "external-title": "HC Tester",
178 "qr-string": "brella_invite_id=588999&brella_invite_token=0AGDJW",
179 "created-at": "2022-09-02T15:19:09.033Z",
180 "updated-at": "2023-01-29T18:21:23.851Z",
181 "attendee-group-name": "Attendees",
182 "seat-count": "1",
183 "free-seat-count": "1"
184 },
185 "relationships": {
186 "attendee-group": {
187 "data": {
188 "id": "11428",
189 "type": "attendee-group"
190 }
191 },
192 "seats": {
193 "data": [
194 {
195 "id": "3214445",
196 "type": "seat"
197 }
198 ]
199 },
200 "free-seats": {
201 "data": [
202 {
203 "id": "3214445",
204 "type": "seat"
205 }
206 ]
207 },
208 "question-responses": {
209 "data": []
210 }
211 }
212 },
213 {
214 "id": "712424",
215 "type": "invite",
216 "attributes": {
217 "fill-token": "LDIZXG",
218 "external-email": "[email protected]",
219 "external-id": "ck-12326",
220 "external-first-name": "Cheri",
221 "external-last-name": "Macabbon",
222 "external-company": "PuffPiece Ltd.",
223 "external-title": "Sr. Editor",
224 "qr-string": "brella_invite_id=712424&brella_invite_token=LDIZXG",
225 "created-at": "2023-01-24T20:01:21.245Z",
226 "updated-at": "2023-01-29T18:21:23.805Z",
227 "attendee-group-name": "Attendees",
228 "seat-count": "4",
229 "free-seat-count": "4"
230 },
231 "relationships": {
232 "attendee-group": {
233 "data": {
234 "id": "11428",
235 "type": "attendee-group"
236 }
237 },
238 "seats": {
239 "data": [
240 {
241 "id": "3583599",
242 "type": "seat"
243 },
244 {
245 "id": "3583598",
246 "type": "seat"
247 },
248 {
249 "id": "3583597",
250 "type": "seat"
251 },
252 {
253 "id": "3583596",
254 "type": "seat"
255 }
256 ]
257 },
258 "free-seats": {
259 "data": [
260 {
261 "id": "3583599",
262 "type": "seat"
263 },
264 {
265 "id": "3583598",
266 "type": "seat"
267 },
268 {
269 "id": "3583597",
270 "type": "seat"
271 },
272 {
273 "id": "3583596",
274 "type": "seat"
275 }
276 ]
277 },
278 "question-responses": {
279 "data": []
280 }
281 }
282 },
283 {
284 "id": "712425",
285 "type": "invite",
286 "attributes": {
287 "fill-token": "LLJENY",
288 "external-email": "[email protected]",
289 "external-id": "xk-13457",
290 "external-first-name": "Pugsy",
291 "external-last-name": "Addamsson",
292 "external-company": "CoLabo0",
293 "external-title": "CTO",
294 "qr-string": "brella_invite_id=712425&brella_invite_token=LLJENY",
295 "created-at": "2023-01-24T20:02:40.532Z",
296 "updated-at": "2023-01-29T18:21:23.782Z",
297 "attendee-group-name": "Attendees",
298 "seat-count": "2",
299 "free-seat-count": "2"
300 },
301 "relationships": {
302 "attendee-group": {
303 "data": {
304 "id": "11428",
305 "type": "attendee-group"
306 }
307 },
308 "seats": {
309 "data": [
310 {
311 "id": "3583601",
312 "type": "seat"
313 },
314 {
315 "id": "3583600",
316 "type": "seat"
317 }
318 ]
319 },
320 "free-seats": {
321 "data": [
322 {
323 "id": "3583601",
324 "type": "seat"
325 },
326 {
327 "id": "3583600",
328 "type": "seat"
329 }
330 ]
331 },
332 "question-responses": {
333 "data": []
334 }
335 }
336 },
337 {
338 "id": "712426",
339 "type": "invite",
340 "attributes": {
341 "fill-token": "HTSQIU",
342 "external-email": "[email protected]",
343 "external-id": "ab13075",
344 "external-first-name": "John",
345 "external-last-name": "McTestersson",
346 "external-company": "Testers 3075",
347 "external-title": "QA ",
348 "qr-string": "brella_invite_id=712426&brella_invite_token=HTSQIU",
349 "created-at": "2023-01-24T20:03:26.637Z",
350 "updated-at": "2023-01-29T18:21:23.759Z",
351 "attendee-group-name": "Attendees",
352 "seat-count": "5",
353 "free-seat-count": "5"
354 },
355 "relationships": {
356 "attendee-group": {
357 "data": {
358 "id": "11428",
359 "type": "attendee-group"
360 }
361 },
362 "seats": {
363 "data": [
364 {
365 "id": "3583608",
366 "type": "seat"
367 },
368 {
369 "id": "3583607",
370 "type": "seat"
371 },
372 {
373 "id": "3583606",
374 "type": "seat"
375 },
376 {
377 "id": "3583605",
378 "type": "seat"
379 },
380 {
381 "id": "3583604",
382 "type": "seat"
383 }
384 ]
385 },
386 "free-seats": {
387 "data": [
388 {
389 "id": "3583608",
390 "type": "seat"
391 },
392 {
393 "id": "3583607",
394 "type": "seat"
395 },
396 {
397 "id": "3583606",
398 "type": "seat"
399 },
400 {
401 "id": "3583605",
402 "type": "seat"
403 },
404 {
405 "id": "3583604",
406 "type": "seat"
407 }
408 ]
409 },
410 "question-responses": {
411 "data": []
412 }
413 }
414 },
415 {
416 "id": "479047",
417 "type": "invite",
418 "attributes": {
419 "fill-token": "JF1ZMI",
420 "external-email": "[email protected]",
421 "external-id": "iljl90-099",
422 "external-first-name": "Sophie",
423 "external-last-name": "LeMarc",
424 "external-company": "Brella Co",
425 "external-title": "Tester",
426 "qr-string": "brella_invite_id=479047&brella_invite_token=JF1ZMI",
427 "created-at": "2022-04-14T08:55:35.560Z",
428 "updated-at": "2023-01-29T18:21:23.894Z",
429 "attendee-group-name": "Attendees",
430 "seat-count": "1",
431 "free-seat-count": "1"
432 },
433 "relationships": {
434 "attendee-group": {
435 "data": {
436 "id": "11428",
437 "type": "attendee-group"
438 }
439 },
440 "seats": {
441 "data": [
442 {
443 "id": "3583573",
444 "type": "seat"
445 }
446 ]
447 },
448 "free-seats": {
449 "data": [
450 {
451 "id": "3583573",
452 "type": "seat"
453 }
454 ]
455 },
456 "question-responses": {
457 "data": []
458 }
459 }
460 },
461 {
462 "id": "479044",
463 "type": "invite",
464 "attributes": {
465 "fill-token": "2PJ16U",
466 "external-email": "[email protected]",
467 "external-id": "90j-skfl9",
468 "external-first-name": "Jane",
469 "external-last-name": "Smithsonian",
470 "external-company": "Brella Co.",
471 "external-title": "Chief Experience Officer",
472 "qr-string": "brella_invite_id=479044&brella_invite_token=2PJ16U",
473 "created-at": "2022-04-14T07:45:25.657Z",
474 "updated-at": "2023-01-29T18:21:23.971Z",
475 "attendee-group-name": "Attendees",
476 "seat-count": "1",
477 "free-seat-count": "1"
478 },
479 "relationships": {
480 "attendee-group": {
481 "data": {
482 "id": "11428",
483 "type": "attendee-group"
484 }
485 },
486 "seats": {
487 "data": [
488 {
489 "id": "3583572",
490 "type": "seat"
491 }
492 ]
493 },
494 "free-seats": {
495 "data": [
496 {
497 "id": "3583572",
498 "type": "seat"
499 }
500 ]
501 },
502 "question-responses": {
503 "data": []
504 }
505 }
506 }
507 ],
508 "included": [
509 {
510 "id": "3414488",
511 "type": "seat",
512 "attributes": {
513 "token": "MIN1MI"
514 },
515 "relationships": {
516 "attendee": {
517 "data": {
518 "id": "1127479",
519 "type": "attendee"
520 }
521 }
522 }
523 },
524 {
525 "id": "11428",
526 "type": "attendee-group",
527 "attributes": {
528 "name": "Attendees",
529 "attendance-type": "virtual",
530 "default": "true",
531 "users-are-deletable": "false",
532 "created-at": "2022-04-13T11:18:36.831Z",
533 "updated-at": "2022-04-13T11:18:36.831Z",
534 "attendees-count": {}
535 },
536 "relationships": {
537 "attendees": {
538 "data": []
539 }
540 }
541 },
542 {
543 "id": "828510",
544 "type": "seat",
545 "attributes": {
546 "token": "2SVG6A"
547 },
548 "relationships": {
549 "attendee": {
550 "data": {
551 "id": "982409",
552 "type": "attendee"
553 }
554 }
555 }
556 },
557 {
558 "id": "828511",
559 "type": "seat",
560 "attributes": {
561 "token": "7OJ5BA"
562 },
563 "relationships": {
564 "attendee": {
565 "data": {
566 "id": "982404",
567 "type": "attendee"
568 }
569 }
570 }
571 },
572 {
573 "id": "828513",
574 "type": "seat",
575 "attributes": {
576 "token": "NBIRCV"
577 },
578 "relationships": {
579 "attendee": {
580 "data": {
581 "id": "982386",
582 "type": "attendee"
583 }
584 }
585 }
586 },
587 {
588 "id": "3214445",
589 "type": "seat",
590 "attributes": {
591 "token": "0AGDJW"
592 },
593 "relationships": {
594 "attendee": {
595 "data": {}
596 }
597 }
598 },
599 {
600 "id": "3583599",
601 "type": "seat",
602 "attributes": {
603 "token": "LDIZXG"
604 },
605 "relationships": {
606 "attendee": {
607 "data": {}
608 }
609 }
610 },
611 {
612 "id": "3583598",
613 "type": "seat",
614 "attributes": {
615 "token": "LDIZXG"
616 },
617 "relationships": {
618 "attendee": {
619 "data": {}
620 }
621 }
622 },
623 {
624 "id": "3583597",
625 "type": "seat",
626 "attributes": {
627 "token": "LDIZXG"
628 },
629 "relationships": {
630 "attendee": {
631 "data": {}
632 }
633 }
634 },
635 {
636 "id": "3583596",
637 "type": "seat",
638 "attributes": {
639 "token": "LDIZXG"
640 },
641 "relationships": {
642 "attendee": {
643 "data": {}
644 }
645 }
646 },
647 {
648 "id": "3583601",
649 "type": "seat",
650 "attributes": {
651 "token": "LLJENY"
652 },
653 "relationships": {
654 "attendee": {
655 "data": {}
656 }
657 }
658 },
659 {
660 "id": "3583600",
661 "type": "seat",
662 "attributes": {
663 "token": "LLJENY"
664 },
665 "relationships": {
666 "attendee": {
667 "data": {}
668 }
669 }
670 },
671 {
672 "id": "3583608",
673 "type": "seat",
674 "attributes": {
675 "token": "HTSQIU"
676 },
677 "relationships": {
678 "attendee": {
679 "data": {}
680 }
681 }
682 },
683 {
684 "id": "3583607",
685 "type": "seat",
686 "attributes": {
687 "token": "HTSQIU"
688 },
689 "relationships": {
690 "attendee": {
691 "data": {}
692 }
693 }
694 },
695 {
696 "id": "3583606",
697 "type": "seat",
698 "attributes": {
699 "token": "HTSQIU"
700 },
701 "relationships": {
702 "attendee": {
703 "data": {}
704 }
705 }
706 },
707 {
708 "id": "3583605",
709 "type": "seat",
710 "attributes": {
711 "token": "HTSQIU"
712 },
713 "relationships": {
714 "attendee": {
715 "data": {}
716 }
717 }
718 },
719 {
720 "id": "3583604",
721 "type": "seat",
722 "attributes": {
723 "token": "HTSQIU"
724 },
725 "relationships": {
726 "attendee": {
727 "data": {}
728 }
729 }
730 },
731 {
732 "id": "3583573",
733 "type": "seat",
734 "attributes": {
735 "token": "JF1ZMI"
736 },
737 "relationships": {
738 "attendee": {
739 "data": {}
740 }
741 }
742 },
743 {
744 "id": "3583572",
745 "type": "seat",
746 "attributes": {
747 "token": "2PJ16U"
748 },
749 "relationships": {
750 "attendee": {
751 "data": {}
752 }
753 }
754 }
755 ]
756}
Notes:
- This endpoint accepts the following URL parameters for filtering:
- created_from
- updated_from
- created_to
- updated_to
- Please supply the date in the following format: 2023-11-20T00:00:00.000Z
Updated 09 Dec 2024
Did this page help you?