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

Get invite by id

1min
Get the data for a specific invite within an event using its unique identifier
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
{inviteId}
required
Number
The id of the invite you are trying to retrieve
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/{inviteId}' \
--header 'Brella-API-Access-Token: String' \
--header 'Accept: application/vnd.brella.v4+json' \
--header 'Content-Type: application/json'
Responses
200
{
  "data": {
    "id": "712425",
    "type": "invite",
    "attributes": {
      "fill-token": "LLJENY",
      "external-email": "testing+invites3457@example.com",
      "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": []
      }
    }
  },
  "included": [
    {
      "id": "3583601",
      "type": "seat",
      "attributes": {
        "token": "LLJENY"
      },
      "relationships": {
        "attendee": {
          "data": {}
        }
      }
    },
    {
      "id": "3583600",
      "type": "seat",
      "attributes": {
        "token": "LLJENY"
      },
      "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 13 Apr 2023
Did this page help you?
PREVIOUS
List all invites
NEXT
Find invite by external id
Docs powered by Archbee
TABLE OF CONTENTS
GET
Get specific invite by id
Docs powered by Archbee