Invites
List all user groups / attendee groups
1min
List all user / attendee groups 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
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}/attendee_groups' \
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": "13162",
5 "type": "attendee-group",
6 "attributes": {
7 "name": "Attendees (Virtual)",
8 "attendance-type": "virtual",
9 "default": true,
10 "users-are-deletable": true,
11 "created-at": "2022-08-30T16:26:28.393Z",
12 "updated-at": "2022-08-30T16:26:28.393Z",
13 "attendees-count": 0
14 },
15
16 {
17 "id": "13163",
18 "type": "attendee-group",
19 "attributes": {
20 "name": "Attendees (In-Person)",
21 "attendance-type": "in_person",
22 "default": true,
23 "users-are-deletable": true,
24 "created-at": "2022-08-30T16:26:28.397Z",
25 "updated-at": "2022-08-30T16:26:28.397Z",
26 "attendees-count": 0
27 },
28
29 {
30 "id": "13164",
31 "type": "attendee-group",
32 "attributes": {
33 "name": "Attendees (Hybrid)",
34 "attendance-type": "hybrid",
35 "default": true,
36 "users-are-deletable": false,
37 "created-at": "2022-08-30T16:26:28.400Z",
38 "updated-at": "2022-08-30T16:26:28.400Z",
39 "attendees-count": 6
40 },
41
42 {
43 "id": "13165",
44 "type": "attendee-group",
45 "attributes": {
46 "name": "Sponsors (Virtual)",
47 "attendance-type": "virtual",
48 "default": true,
49 "users-are-deletable": true,
50 "created-at": "2022-08-30T16:26:28.404Z",
51 "updated-at": "2022-08-30T16:26:28.404Z",
52 "attendees-count": 0
53 },
54
55 {
56 "id": "13166",
57 "type": "attendee-group",
58 "attributes": {
59 "name": "Sponsors (In-Person)",
60 "attendance-type": "in_person",
61 "default": true,
62 "users-are-deletable": true,
63 "created-at": "2022-08-30T16:26:28.407Z",
64 "updated-at": "2022-08-30T16:26:28.407Z",
65 "attendees-count": 0
66 },
67
68 {
69 "id": "13167",
70 "type": "attendee-group",
71 "attributes": {
72 "name": "Sponsors (Hybrid)",
73 "attendance-type": "hybrid",
74 "default": true,
75 "users-are-deletable": false,
76 "created-at": "2022-08-30T16:26:28.410Z",
77 "updated-at": "2022-08-30T16:26:28.410Z",
78 "attendees-count": 0
79 },
80
81 {
82 "id": "15467",
83 "type": "attendee-group",
84 "attributes": {
85 "name": "Test Group",
86 "attendance-type": "virtual",
87 "default": false,
88 "users-are-deletable": true,
89 "created-at": "2023-02-21T12:00:21.936Z",
90 "updated-at": "2023-07-12T15:08:33.120Z",
91 "attendees-count": 0
92 },
93
94 {
95 "id": "15468",
96 "type": "attendee-group",
97 "attributes": {
98 "name": "Test Group 2",
99 "attendance-type": "virtual",
100 "default": false,
101 "users-are-deletable": true,
102 "created-at": "2023-02-21T12:02:36.920Z",
103 "updated-at": "2023-02-21T12:02:56.020Z",
104 "attendees-count": 0
105 },
106
107 {
108 "id": "15469",
109 "type": "attendee-group",
110 "attributes": {
111 "name": "test",
112 "attendance-type": "virtual",
113 "default": false,
114 "users-are-deletable": true,
115 "created-at": "2023-02-21T12:23:59.503Z",
116 "updated-at": "2023-02-21T12:23:59.503Z",
117 "attendees-count": 0
118 },
119
120 "meta": {
121 "total_count": 9,
122 "total_pages": 1,
123 "current_page": 1
124 }
125}
Note:
- The current response returns the associated attendees for each group. This will be removed soon for performance considerations.
Updated 16 Aug 2023
Did this page help you?