Website logo
⌘K
API quickstart
Welcome
Forming API requests
Response status codes
Rate-limiting & pagination
How data is structured in Brella
A note on external_id fields
Authentication & API keys
Changelog
Events
Invites
Attendees
RSVP & Session check-in
Get all RSVPs by attendee id
Get all RSVPs by timeslot id
Create RSVP for timeslot
Delete RSVP from timeslot
Sponsors
Speakers
Schedule
Statistics & analytics
Get all meetings & chats by attendee id (cloned)
Get meeting or chat by id
Get tracking sessions by attendee id
Get tracking session slices by attendee id
Webhooks
Docs powered by Archbee
Invites

Find invite by email

1min
Find an invite (or many invites) by searching for them by the associated email address
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
external_email
required
String
The email address associated with the invite. Emails are not unique in Brella, as there can be multiple invites for the same email address.
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/find/?external_email={emailAddress}' \
--header 'Brella-API-Access-Token: String' \
--header 'Accept: application/vnd.brella.v4+json' \
--header 'Content-Type: application/json'
Responses
200
{
  "data": {
    "id": "712426",
    "type": "invite",
    "attributes": {
      "fill-token": "HTSQIU",
      "external-email": "testing+invites3075@example.com",
      "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": []
      }
    }
  },
  "included": [
    {
      "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": "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": []
        }
      }
    }
  ]
}




Updated 15 Nov 2023
Did this page help you?
PREVIOUS
Find invite by external id
NEXT
Find invite by company name
Docs powered by Archbee
TABLE OF CONTENTS
GET
Find invite by email
Docs powered by Archbee