Invites
List all invites
1min
List all invites in a specific event
GET
Params
Path Params
{organizationId}
required
Number
The id of the Brella organization you are trying to retrieve data from
{eventId}
required
Number
The id of the Brella event you are trying to retrieve data from
Query Parameters
page[size]
optional
Number
Paginate the response of this endpoint. By default Brella's endpoints do not enforce pagination
page[number]
optional
Number
Retrieve a specific page of results if pagination is enabled using the previous parameter
created_from
optional
String
Retrieve entries created from this datetime. Provide the date in the format: 2023-05-02T00:00:00.000Z
created_to
optional
String
Retrieve entries created until this datetime. Provide the date in the format: 2023-05-02T00:00:00.000Z
updated_from
optional
String
Retrieve entries updated from this datetime. Provide the date in the format: 2023-05-02T00:00:00.000Z
updated_to
optional
String
Retrieve entries updated until this datetime. Provide the date in the format: 2023-05-02T00:00:00.000Z
Header Parameters
Brella-API-Access-Token
required
String
Your unique Brella API key
Accept
required
String
application/vnd.brella.v4+json
Content-Type
required
String
application/json
Curl
curl --location -g --request GET 'https://api.brella.io/api/integration/organizations/{organizationId}/events/{eventId}/invites' \
--header 'Brella-API-Access-Token: String' \
--header 'Accept: application/vnd.brella.v4+json' \
--header 'Content-Type: application/json'
Responses
200
{
"data": [
{
"id": "633630",
"type": "invite",
"attributes": {
"fill-token": "MIN1MI",
"external-email": "[email protected]",
"external-id": "kd-34rfo0",
"external-first-name": "Kav",
"external-last-name": "McTestersson",
"external-company": "Brella",
"external-title": "PM",
"qr-string": "brella_invite_id=633630&brella_invite_token=MIN1MI",
"created-at": "2022-09-27T12:15:15.396Z",
"updated-at": "2023-01-29T18:37:42.293Z",
"attendee-group-name": "Attendees",
"seat-count": "1",
"free-seat-count": "0"
},
"relationships": {
"attendee-group": {
"data": {
"id": "11428",
"type": "attendee-group"
}
},
"seats": {
"data": [
{
"id": "3414488",
"type": "seat"
}
]
},
"free-seats": {
"data": []
},
"question-responses": {
"data": []
}
}
},
{
"id": "479045",
"type": "invite",
"attributes": {
"fill-token": "2SVG6A",
"external-email": "[email protected]",
"external-id": "lj09-909kl",
"external-first-name": "Steffi",
"external-last-name": "Val",
"external-company": "Zod Co.",
"external-title": "Tech Support Lead",
"qr-string": "brella_invite_id=479045&brella_invite_token=2SVG6A",
"created-at": "2022-04-14T08:52:54.432Z",
"updated-at": "2023-01-29T18:21:23.942Z",
"attendee-group-name": "Attendees",
"seat-count": "1",
"free-seat-count": "0"
},
"relationships": {
"attendee-group": {
"data": {
"id": "11428",
"type": "attendee-group"
}
},
"seats": {
"data": [
{
"id": "828510",
"type": "seat"
}
]
},
"free-seats": {
"data": []
},
"question-responses": {
"data": []
}
}
},
{
"id": "479046",
"type": "invite",
"attributes": {
"fill-token": "7OJ5BA",
"external-email": "[email protected]",
"external-id": "8kl0-9hjl",
"external-first-name": "Wen",
"external-last-name": "Lando",
"external-company": "Abacus Co.,",
"external-title": "CSM",
"qr-string": "brella_invite_id=479046&brella_invite_token=7OJ5BA",
"created-at": "2022-04-14T08:54:27.165Z",
"updated-at": "2023-01-29T18:21:23.919Z",
"attendee-group-name": "Attendees",
"seat-count": "1",
"free-seat-count": "0"
},
"relationships": {
"attendee-group": {
"data": {
"id": "11428",
"type": "attendee-group"
}
},
"seats": {
"data": [
{
"id": "828511",
"type": "seat"
}
]
},
"free-seats": {
"data": []
},
"question-responses": {
"data": []
}
}
},
{
"id": "479048",
"type": "invite",
"attributes": {
"fill-token": "NBIRCV",
"external-email": "[email protected]",
"external-id": "kzkz0-20",
"external-first-name": "Ville",
"external-last-name": "Jonah-Smith",
"external-company": "Brella",
"external-title": "Founder/ CSM Lead",
"qr-string": "brella_invite_id=479048&brella_invite_token=NBIRCV",
"created-at": "2022-04-14T08:56:59.940Z",
"updated-at": "2023-01-29T18:21:23.872Z",
"attendee-group-name": "Attendees",
"seat-count": "1",
"free-seat-count": "0"
},
"relationships": {
"attendee-group": {
"data": {
"id": "11428",
"type": "attendee-group"
}
},
"seats": {
"data": [
{
"id": "828513",
"type": "seat"
}
]
},
"free-seats": {
"data": []
},
"question-responses": {
"data": []
}
}
},
{
"id": "588999",
"type": "invite",
"attributes": {
"fill-token": "0AGDJW",
"external-email": "[email protected]",
"external-id": "ma-at930",
"external-first-name": "Sophie",
"external-last-name": "DiPalo",
"external-company": "Brella",
"external-title": "HC Tester",
"qr-string": "brella_invite_id=588999&brella_invite_token=0AGDJW",
"created-at": "2022-09-02T15:19:09.033Z",
"updated-at": "2023-01-29T18:21:23.851Z",
"attendee-group-name": "Attendees",
"seat-count": "1",
"free-seat-count": "1"
},
"relationships": {
"attendee-group": {
"data": {
"id": "11428",
"type": "attendee-group"
}
},
"seats": {
"data": [
{
"id": "3214445",
"type": "seat"
}
]
},
"free-seats": {
"data": [
{
"id": "3214445",
"type": "seat"
}
]
},
"question-responses": {
"data": []
}
}
},
{
"id": "712424",
"type": "invite",
"attributes": {
"fill-token": "LDIZXG",
"external-email": "[email protected]",
"external-id": "ck-12326",
"external-first-name": "Cheri",
"external-last-name": "Macabbon",
"external-company": "PuffPiece Ltd.",
"external-title": "Sr. Editor",
"qr-string": "brella_invite_id=712424&brella_invite_token=LDIZXG",
"created-at": "2023-01-24T20:01:21.245Z",
"updated-at": "2023-01-29T18:21:23.805Z",
"attendee-group-name": "Attendees",
"seat-count": "4",
"free-seat-count": "4"
},
"relationships": {
"attendee-group": {
"data": {
"id": "11428",
"type": "attendee-group"
}
},
"seats": {
"data": [
{
"id": "3583599",
"type": "seat"
},
{
"id": "3583598",
"type": "seat"
},
{
"id": "3583597",
"type": "seat"
},
{
"id": "3583596",
"type": "seat"
}
]
},
"free-seats": {
"data": [
{
"id": "3583599",
"type": "seat"
},
{
"id": "3583598",
"type": "seat"
},
{
"id": "3583597",
"type": "seat"
},
{
"id": "3583596",
"type": "seat"
}
]
},
"question-responses": {
"data": []
}
}
},
{
"id": "712425",
"type": "invite",
"attributes": {
"fill-token": "LLJENY",
"external-email": "[email protected]",
"external-id": "xk-13457",
"external-first-name": "Pugsy",
"external-last-name": "Addamsson",
"external-company": "CoLabo0",
"external-title": "CTO",
"qr-string": "brella_invite_id=712425&brella_invite_token=LLJENY",
"created-at": "2023-01-24T20:02:40.532Z",
"updated-at": "2023-01-29T18:21:23.782Z",
"attendee-group-name": "Attendees",
"seat-count": "2",
"free-seat-count": "2"
},
"relationships": {
"attendee-group": {
"data": {
"id": "11428",
"type": "attendee-group"
}
},
"seats": {
"data": [
{
"id": "3583601",
"type": "seat"
},
{
"id": "3583600",
"type": "seat"
}
]
},
"free-seats": {
"data": [
{
"id": "3583601",
"type": "seat"
},
{
"id": "3583600",
"type": "seat"
}
]
},
"question-responses": {
"data": []
}
}
},
{
"id": "712426",
"type": "invite",
"attributes": {
"fill-token": "HTSQIU",
"external-email": "[email protected]",
"external-id": "ab13075",
"external-first-name": "John",
"external-last-name": "McTestersson",
"external-company": "Testers 3075",
"external-title": "QA ",
"qr-string": "brella_invite_id=712426&brella_invite_token=HTSQIU",
"created-at": "2023-01-24T20:03:26.637Z",
"updated-at": "2023-01-29T18:21:23.759Z",
"attendee-group-name": "Attendees",
"seat-count": "5",
"free-seat-count": "5"
},
"relationships": {
"attendee-group": {
"data": {
"id": "11428",
"type": "attendee-group"
}
},
"seats": {
"data": [
{
"id": "3583608",
"type": "seat"
},
{
"id": "3583607",
"type": "seat"
},
{
"id": "3583606",
"type": "seat"
},
{
"id": "3583605",
"type": "seat"
},
{
"id": "3583604",
"type": "seat"
}
]
},
"free-seats": {
"data": [
{
"id": "3583608",
"type": "seat"
},
{
"id": "3583607",
"type": "seat"
},
{
"id": "3583606",
"type": "seat"
},
{
"id": "3583605",
"type": "seat"
},
{
"id": "3583604",
"type": "seat"
}
]
},
"question-responses": {
"data": []
}
}
},
{
"id": "479047",
"type": "invite",
"attributes": {
"fill-token": "JF1ZMI",
"external-email": "[email protected]",
"external-id": "iljl90-099",
"external-first-name": "Sophie",
"external-last-name": "LeMarc",
"external-company": "Brella Co",
"external-title": "Tester",
"qr-string": "brella_invite_id=479047&brella_invite_token=JF1ZMI",
"created-at": "2022-04-14T08:55:35.560Z",
"updated-at": "2023-01-29T18:21:23.894Z",
"attendee-group-name": "Attendees",
"seat-count": "1",
"free-seat-count": "1"
},
"relationships": {
"attendee-group": {
"data": {
"id": "11428",
"type": "attendee-group"
}
},
"seats": {
"data": [
{
"id": "3583573",
"type": "seat"
}
]
},
"free-seats": {
"data": [
{
"id": "3583573",
"type": "seat"
}
]
},
"question-responses": {
"data": []
}
}
},
{
"id": "479044",
"type": "invite",
"attributes": {
"fill-token": "2PJ16U",
"external-email": "[email protected]",
"external-id": "90j-skfl9",
"external-first-name": "Jane",
"external-last-name": "Smithsonian",
"external-company": "Brella Co.",
"external-title": "Chief Experience Officer",
"qr-string": "brella_invite_id=479044&brella_invite_token=2PJ16U",
"created-at": "2022-04-14T07:45:25.657Z",
"updated-at": "2023-01-29T18:21:23.971Z",
"attendee-group-name": "Attendees",
"seat-count": "1",
"free-seat-count": "1"
},
"relationships": {
"attendee-group": {
"data": {
"id": "11428",
"type": "attendee-group"
}
},
"seats": {
"data": [
{
"id": "3583572",
"type": "seat"
}
]
},
"free-seats": {
"data": [
{
"id": "3583572",
"type": "seat"
}
]
},
"question-responses": {
"data": []
}
}
}
],
"included": [
{
"id": "3414488",
"type": "seat",
"attributes": {
"token": "MIN1MI"
},
"relationships": {
"attendee": {
"data": {
"id": "1127479",
"type": "attendee"
}
}
}
},
{
"id": "11428",
"type": "attendee-group",
"attributes": {
"name": "Attendees",
"attendance-type": "virtual",
"default": "true",
"users-are-deletable": "false",
"created-at": "2022-04-13T11:18:36.831Z",
"updated-at": "2022-04-13T11:18:36.831Z",
"attendees-count": {}
},
"relationships": {
"attendees": {
"data": []
}
}
},
{
"id": "828510",
"type": "seat",
"attributes": {
"token": "2SVG6A"
},
"relationships": {
"attendee": {
"data": {
"id": "982409",
"type": "attendee"
}
}
}
},
{
"id": "828511",
"type": "seat",
"attributes": {
"token": "7OJ5BA"
},
"relationships": {
"attendee": {
"data": {
"id": "982404",
"type": "attendee"
}
}
}
},
{
"id": "828513",
"type": "seat",
"attributes": {
"token": "NBIRCV"
},
"relationships": {
"attendee": {
"data": {
"id": "982386",
"type": "attendee"
}
}
}
},
{
"id": "3214445",
"type": "seat",
"attributes": {
"token": "0AGDJW"
},
"relationships": {
"attendee": {
"data": {}
}
}
},
{
"id": "3583599",
"type": "seat",
"attributes": {
"token": "LDIZXG"
},
"relationships": {
"attendee": {
"data": {}
}
}
},
{
"id": "3583598",
"type": "seat",
"attributes": {
"token": "LDIZXG"
},
"relationships": {
"attendee": {
"data": {}
}
}
},
{
"id": "3583597",
"type": "seat",
"attributes": {
"token": "LDIZXG"
},
"relationships": {
"attendee": {
"data": {}
}
}
},
{
"id": "3583596",
"type": "seat",
"attributes": {
"token": "LDIZXG"
},
"relationships": {
"attendee": {
"data": {}
}
}
},
{
"id": "3583601",
"type": "seat",
"attributes": {
"token": "LLJENY"
},
"relationships": {
"attendee": {
"data": {}
}
}
},
{
"id": "3583600",
"type": "seat",
"attributes": {
"token": "LLJENY"
},
"relationships": {
"attendee": {
"data": {}
}
}
},
{
"id": "3583608",
"type": "seat",
"attributes": {
"token": "HTSQIU"
},
"relationships": {
"attendee": {
"data": {}
}
}
},
{
"id": "3583607",
"type": "seat",
"attributes": {
"token": "HTSQIU"
},
"relationships": {
"attendee": {
"data": {}
}
}
},
{
"id": "3583606",
"type": "seat",
"attributes": {
"token": "HTSQIU"
},
"relationships": {
"attendee": {
"data": {}
}
}
},
{
"id": "3583605",
"type": "seat",
"attributes": {
"token": "HTSQIU"
},
"relationships": {
"attendee": {
"data": {}
}
}
},
{
"id": "3583604",
"type": "seat",
"attributes": {
"token": "HTSQIU"
},
"relationships": {
"attendee": {
"data": {}
}
}
},
{
"id": "3583573",
"type": "seat",
"attributes": {
"token": "JF1ZMI"
},
"relationships": {
"attendee": {
"data": {}
}
}
},
{
"id": "3583572",
"type": "seat",
"attributes": {
"token": "2PJ16U"
},
"relationships": {
"attendee": {
"data": {}
}
}
}
]
}
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 21 Nov 2023
Did this page help you?