Introduction

Welcome to Brella's API. You can use this API to access all of our publicly available API endpoints, in order to integrate your 3rd party tools with Brella's event platform. For example, our Event Invites endpoints offer read / write access to your event's invitations.The following information will help you get started:

Base URL

This is the URL that should prefix all requests: https://api.brella.io. All requests should be made over SSL.

Authentication

Authentication works by sending your unique API key using the Brella-API-Access-Token header to your request.

To get an API key, please reach out to your Brella contact (most likely your Customer Success Manager, or Key Account Manager). A self-service system is currently on our roadmap, but we don't have an ETA.

Content type & data format

The Brella API works with json data. In addition to the Authentication header (Brella-API-Access-Token: [APIKEY]), you must also add the following headers to all of your requests:

Content-Type: application/json
Accept: application/vnd.brella.v4+json

This API is organized around REST. All request and response bodies, including errors, are encoded in JSON.

Request bodies have no root element and snake_case for object keys.

Response bodies comply with the JSON:API specification.

Reponse status codes

2xx – The response was successfull.

400 Bad Request – Something was wrong with your request. We don't have further details — but we do recommend checking your syntax and parameters to make sure the queried organization ID and event ID exist.

403 Forbidden – You didn't provide a valid API Access Token, or you do not have "Organization Administrator" (Org Admin) privileges within your event's organization on Brella.

404 Not Found – You are trying to access a resource that doesn't exist. This error can also occur if there are issues with the request url. For example, assume that you are trying to GET /api/integration/organizations/1/events/123. While an event with id 123 does exist, it belongs to organization 2. As such, the API would return a response of 404, as it is searching for event 123 in organization 1 — which is an entity that does not exist.

422 Unprocessable Entity – You are trying to create or update a resource with invalid data.

5xx Internal Server Error – Our code crashed. Sorry about that. Our error tracking system probably caught this, and we will look into it soon. However, if you are in a hurry, please reach out to your Brella contact person (most likely your Customer Success Manager or Key Account Manager) to request a quick fix. You can also leave us a message via our Technical Support team.

Testing our API

To familiarize yourself with our API, we recommend trying out a few examples using a REST client called Postman.

Rate limiting

We do not have hard rate limits at present. However, we reserve the right to block unreasonable requests on a case-by-case basis.

API updates

This API is currently in its formative stages and receives regular updates. However, we respect and value stability and backwards compatibility. As such, any breaking changes will be communicated to all API key holding customers via email at least 3 days prior to implementation.

Support

For assistance, please contact your Brella contact (most likely your Customer Success Manager or Key Account Manager). Alternatively, you can create a ticket through our Help Center.

Attendee Groups

Get a specific attendee group

"curl -X GET -H 'Brella-API-Access-Token: vnz2UjRyfq1kDur3jBKx5hSVhPcMUAk9Cec3tuJh' -H 'CONTENT_TYPE: application/json' https://api.brella.io/api/integration/organizations/2319/events/2360/attendee_groups/6137"

{
  "data": {
    "id": "6137",
    "type": "attendee-group",
    "attributes": {
      "name": "bar",
      "attendance-type": "in_person",
      "default": false,
      "users-are-deletable": true,
      "attendees-count": 0
    },
    "relationships": {
      "attendees": {
        "data": [

        ]
      }
    }
  }
}

HTTP Request

GET /api/integration/organizations/:organization_id/events/:event_id/attendee_groups/:id

Response

Type	Attribute	Example value
attendee-group
	name	"bar"
	attendance-type	"in_person"
	default	false
	users-are-deletable	true
	attendees-count	0

Behavior

when the request is successfull
- returns an attendee group object

Get all attendee groups

"curl -X GET -H 'Brella-API-Access-Token: xM6BiZKKBqGO4GbkGrJmGqAIy5ZfW8UyvVbF7Gvg' -H 'CONTENT_TYPE: application/json' https://api.brella.io/api/integration/organizations/2320/events/2361/attendee_groups"

{
  "data": [
    {
      "id": "6138",
      "type": "attendee-group",
      "attributes": {
        "name": "Attendees",
        "attendance-type": "in_person",
        "default": true,
        "users-are-deletable": false,
        "attendees-count": 0
      },
      "relationships": {
        "attendees": {
          "data": [

          ]
        }
      }
    },
    {
      "id": "6139",
      "type": "attendee-group",
      "attributes": {
        "name": "Sponsors",
        "attendance-type": "in_person",
        "default": true,
        "users-are-deletable": false,
        "attendees-count": 0
      },
      "relationships": {
        "attendees": {
          "data": [

          ]
        }
      }
    },
    {
      "id": "6140",
      "type": "attendee-group",
      "attributes": {
        "name": "foo",
        "attendance-type": "in_person",
        "default": false,
        "users-are-deletable": true,
        "attendees-count": 0
      },
      "relationships": {
        "attendees": {
          "data": [

          ]
        }
      }
    },
    {
      "id": "6141",
      "type": "attendee-group",
      "attributes": {
        "name": "bar",
        "attendance-type": "in_person",
        "default": false,
        "users-are-deletable": true,
        "attendees-count": 0
      },
      "relationships": {
        "attendees": {
          "data": [

          ]
        }
      }
    }
  ]
}

HTTP Request

GET /api/integration/organizations/:organization_id/events/:event_id/attendee_groups

Response

Type	Attribute	Example value
attendee-group
	name	"Attendees"
	attendance-type	"in_person"
	default	true
	users-are-deletable	false
	attendees-count	0

Behavior

when the request is successfull
- returns all attendee groups in the event

Find attendee group

"curl -X GET -H 'Brella-API-Access-Token: heV7b4k6S9Cv3ZY0KpeaM66YVzwQ6FD6wPn18CTP' -H 'CONTENT_TYPE: application/json' https://api.brella.io/api/integration/organizations/2321/events/2362/attendee_groups/find?name=sdfajdfaf"

{
  "data": null
}

HTTP Request

GET /api/integration/organizations/:organization_id/events/:event_id/attendee_groups/find

Response

Type	Attribute	Example value

Behavior

when no results are found
- responds with an empty body
when an attendee group matching search terms is found
- returns an attendee group object

Attendees

Get all attendees

"curl -X GET -H 'Brella-API-Access-Token: PGhuVSgPjabZ0AuktIlEoDTJhIVutQHWwlFmNzY7' -H 'CONTENT_TYPE: application/json' https://api.brella.io/api/integration/organizations/2323/events/2364/attendees"

{
  "data": [
    {
      "id": "1169",
      "type": "attendee",
      "attributes": {
        "first-name": "Stephine",
        "last-name": "Roberts",
        "email": "[email protected]",
        "company-title": "Senior Developer",
        "company-name": "Hansen Group"
      },
      "relationships": {
        "event": {
          "data": {
            "id": "2364",
            "type": "event"
          }
        }
      }
    }
  ]
}

HTTP Request

GET /api/integration/organizations/:organization_id/events/:event_id/attendees

Response

Type	Attribute	Example value
attendee
	first-name	"Stephine"
	last-name	"Roberts"
	email	"[email protected]"
	company-title	"Senior Developer"
	company-name	"Hansen Group"

Behavior

when the request is successfull
- returns all attendees in the event

Get a specific attendee

"curl -X GET -H 'Brella-API-Access-Token: lRQHOTHi8J4OoX77w1eU4wbEWoV1ZBHCj2J1dVC9' -H 'CONTENT_TYPE: application/json' https://api.brella.io/api/integration/organizations/2324/events/2365/attendees/1170"

{
  "data": {
    "id": "1170",
    "type": "attendee",
    "attributes": {
      "first-name": "Mario",
      "last-name": "Thiel",
      "email": "[email protected]",
      "company-title": "Design Strategist",
      "company-name": "Ziemann Group"
    },
    "relationships": {
      "event": {
        "data": {
          "id": "2365",
          "type": "event"
        }
      }
    }
  }
}

HTTP Request

GET /api/integration/organizations/:organization_id/events/:event_id/attendees/:id

Response

Type	Attribute	Example value
attendee
	first-name	"Mario"
	last-name	"Thiel"
	email	"[email protected]"
	company-title	"Design Strategist"
	company-name	"Ziemann Group"

Behavior

when the request is successfull
- returns an attendee object

Find attendee

"curl -X GET -H 'Brella-API-Access-Token: NMRN3CMEfcFTC3DM42xqB1SwHZJIivyQtZL8QrW3' -H 'CONTENT_TYPE: application/json' https://api.brella.io/api/integration/organizations/2325/events/2366/attendees/find?email=foo%40example.com"

{
  "data": null
}

HTTP Request

GET /api/integration/organizations/:organization_id/events/:event_id/attendees/find

Response

Type	Attribute	Example value

Behavior

when no results are found
- responds with an empty body
when an attendee matching search terms is found
- returns an attendee object

Communities

Get a specific community

"curl -X GET -H 'Brella-API-Access-Token: wZRJEI4T5BH8hoBTAnVW1sdTlCVfJUQWd8jowB7S' -H 'CONTENT_TYPE: application/json' https://api.brella.io/api/integration/organizations/2338/communities/20"

{
  "data": {
    "id": "20",
    "type": "community",
    "attributes": {
      "id": 20,
      "name": "Cardguard",
      "description": "Et molestiae deleniti consectetur.",
      "slug": "foobar",
      "max-number-of-breakout-rooms": 24,
      "created-at": "2022-09-08T08:58:36.154Z",
      "updated-at": "2022-09-08T08:58:36.154Z",
      "cover-image": {
        "url": null
      },
      "logo-large": {
        "url": null
      },
      "logo-small": {
        "url": null
      },
      "member-count": 0
    },
    "relationships": {
      "organization": {
        "data": {
          "id": "2338",
          "type": "organization"
        }
      }
    }
  }
}

HTTP Request

GET /api/integration/organizations/:organization_id/communities/:id

Response

Type	Attribute	Example value
community
	id	20
	name	"Cardguard"
	description	"Et molestiae deleniti consectetur."
	slug	"foobar"
	max-number-of-breakout-rooms	24
	created-at	"2022-09-08T08:58:36.154Z"
	updated-at	"2022-09-08T08:58:36.154Z"
	cover-image	{ "url": null }
	logo-large	{ "url": null }
	logo-small	{ "url": null }
	member-count	0

Behavior

when the request is successfull
- returns a community object

Find community

"curl -X GET -H 'Brella-API-Access-Token: sbKaBGcn8Dwtsivk2YwrJeVuoudZntGr1H0LScdg' -H 'CONTENT_TYPE: application/json' https://api.brella.io/api/integration/organizations/2339/communities/find?slug=zedbaz"

{
  "data": null
}

HTTP Request

GET /api/integration/organizations/:organization_id/communities/find

Response

Type	Attribute	Example value

Behavior

when no results are found
- responds with an empty body
when a community matching search terms is found
- returns a community object

Get all communities

"curl -X GET -H 'Brella-API-Access-Token: es5Hl46IR94Z7DmhmrpXM06U03MmPEnqe44W1vQn' -H 'CONTENT_TYPE: application/json' https://api.brella.io/api/integration/organizations/2341/communities"

{
  "data": [
    {
      "id": "23",
      "type": "community",
      "attributes": {
        "id": 23,
        "name": "Aerified",
        "description": "Nisi sit error quia.",
        "slug": "foobar",
        "max-number-of-breakout-rooms": 24,
        "created-at": "2022-09-08T08:58:36.270Z",
        "updated-at": "2022-09-08T08:58:36.270Z",
        "cover-image": {
          "url": null
        },
        "logo-large": {
          "url": null
        },
        "logo-small": {
          "url": null
        },
        "member-count": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "id": "2341",
            "type": "organization"
          }
        }
      }
    }
  ]
}

HTTP Request

GET /api/integration/organizations/:organization_id/communities

Response

Type	Attribute	Example value
community
	id	23
	name	"Aerified"
	description	"Nisi sit error quia."
	slug	"foobar"
	max-number-of-breakout-rooms	24
	created-at	"2022-09-08T08:58:36.270Z"
	updated-at	"2022-09-08T08:58:36.270Z"
	cover-image	{ "url": null }
	logo-large	{ "url": null }
	logo-small	{ "url": null }
	member-count	0

Behavior

when the request is successfull
- returns all communities in the organization

Community Invites

Find invite

"curl -X GET -H 'Brella-API-Access-Token: MtlWDntGPpbO0CNcDD6HhuTldTvewZKSGlvWx1MQ' -H 'CONTENT_TYPE: application/json' https://api.brella.io/api/integration/organizations/2352/communities/24/invites/find?token=JOINONE"

{
  "data": {
    "id": "1",
    "type": "community-invite",
    "attributes": {
      "token": "JOINONE",
      "total-seat-count": 1,
      "claimed-seat-count": 0,
      "created-at": "2022-09-08T08:58:37.610Z"
    }
  }
}

HTTP Request

GET /api/integration/organizations/:organization_id/communities/:community_id/invites/find

Response

Type	Attribute	Example value
community-invite
	token	"JOINONE"
	total-seat-count	1
	claimed-seat-count	0
	created-at	"2022-09-08T08:58:37.610Z"

Behavior

when a community invite matching search terms is found
- returns a community invite object
when no results are found
- responds with an empty body

Get a specific invite

"curl -X GET -H 'Brella-API-Access-Token: LylRyN9r671Nn6wOAmDzIXTzFEfmCFNeRGL1ARbH' -H 'CONTENT_TYPE: application/json' https://api.brella.io/api/integration/organizations/2358/communities/28/invites/5"

{
  "data": {
    "id": "5",
    "type": "community-invite",
    "attributes": {
      "token": "JOINONE",
      "total-seat-count": 1,
      "claimed-seat-count": 0,
      "created-at": "2022-09-08T08:58:37.776Z"
    }
  }
}

HTTP Request

GET /api/integration/organizations/:organization_id/communities/:community_id/invites/:id

Response

Type	Attribute	Example value
community-invite
	token	"JOINONE"
	total-seat-count	1
	claimed-seat-count	0
	created-at	"2022-09-08T08:58:37.776Z"

Behavior

when the request is successfull
- returns a community invite object

Get all invites

"curl -X GET -H 'Brella-API-Access-Token: hoK6SsGXtCJAdXXamiAduN0GDTIPU1u02DfjyDNT' -H 'CONTENT_TYPE: application/json' https://api.brella.io/api/integration/organizations/2361/communities/30/invites"

{
  "data": [
    {
      "id": "7",
      "type": "community-invite",
      "attributes": {
        "token": "JOINONE",
        "total-seat-count": 1,
        "claimed-seat-count": 0,
        "created-at": "2022-09-08T08:58:37.849Z"
      }
    },
    {
      "id": "8",
      "type": "community-invite",
      "attributes": {
        "token": "JOIN123",
        "total-seat-count": 1,
        "claimed-seat-count": 0,
        "created-at": "2022-09-08T08:58:37.852Z"
      }
    }
  ]
}

HTTP Request

GET /api/integration/organizations/:organization_id/communities/:community_id/invites

Response

Type	Attribute	Example value
community-invite
	token	"JOINONE"
	total-seat-count	1
	claimed-seat-count	0
	created-at	"2022-09-08T08:58:37.849Z"

Behavior

when the request is successfull
- returns all invites for the community

Create a new invite

"curl -X POST -H 'Brella-API-Access-Token: 1rlosnKqPstgwnukRd3Vq0wA52XoBuhvalvy7RPW' -H 'CONTENT_TYPE: application/json' -d '{\"community_invite\":{\"token\":\"FOOBAR\",\"total_seat_count\":5}}' https://api.brella.io/api/integration/organizations/2364/communities/32/invites"

{
  "data": {
    "id": "11",
    "type": "community-invite",
    "attributes": {
      "token": "FOOBAR",
      "total-seat-count": 5,
      "claimed-seat-count": 0,
      "created-at": "2022-09-08T08:58:37.943Z"
    }
  }
}

HTTP Request

POST /api/integration/organizations/:organization_id/communities/:community_id/invites

Request Parameters

Object	Attribute	Example value
community_invite	token	nil
community_invite	total_seat_count	nil

Response

Type	Attribute	Example value
community-invite
	token	"FOOBAR"
	total-seat-count	5
	claimed-seat-count	0
	created-at	"2022-09-08T08:58:37.943Z"

Behavior

when all required invite parameters are present
- returns status 200
- creates resource
makes sure tokens dont get duplicated
- returns status 403

Remove a specific invite

"curl -X DELETE -H 'Brella-API-Access-Token: EFsSxhCdNxdEaX3rJci3RoZpX4y9CvdWaePTD8Jl' -H 'CONTENT_TYPE: application/json' https://api.brella.io/api/integration/organizations/2373/communities/38/invites/18"

{
  "data": null
}

HTTP Request

DELETE /api/integration/organizations/:organization_id/communities/:community_id/invites/:id

Response

Type	Attribute	Example value

Behavior

if invite doesnt have a used seat
- deletes resources

Event Invites

Create a new invite

"curl -X POST -H 'Brella-API-Access-Token: HZkZgW2X6jJdc65BtUfIs5CGaYkVWXuwTyYJOqA6' -H 'CONTENT_TYPE: application/json' -d '{\"event_invite\":{\"external_email\":null,\"external_id\":null,\"seats\":5,\"attendee_group_id\":6196}}' https://api.brella.io/api/integration/organizations/2376/events/2385/invites"

{
  "data": {
    "id": "2750",
    "type": "invite",
    "attributes": {
      "fill-token": "E86MWR",
      "external-email": null,
      "external-id": null,
      "external-first-name": null,
      "external-last-name": null,
      "external-company": null,
      "external-title": null,
      "attendee-group-name": "Rich ppl",
      "seat-count": 0
    },
    "relationships": {
      "attendee-group": {
        "data": {
          "id": "6196",
          "type": "attendee-group"
        }
      },
      "seats": {
        "data": [

        ]
      },
      "question-responses": {
        "data": [

        ]
      }
    }
  },
  "included": [
    {
      "id": "6196",
      "type": "attendee-group",
      "attributes": {
        "name": "Rich ppl",
        "attendance-type": "in_person",
        "default": false,
        "users-are-deletable": true,
        "attendees-count": 0
      },
      "relationships": {
        "attendees": {
          "data": [

          ]
        }
      }
    }
  ]
}

HTTP Request

POST /api/integration/organizations/:organization_id/events/:event_id/invites

Request Parameters

Object	Attribute	Example value
event_invite	external_id	nil
	external_email	nil
	external_first_name	nil
	external_last_name	nil
	external_company	nil
	external_title	nil
	seats	nil
	attendee_group_id	nil
	import_id	nil

Response

Type	Attribute	Example value
invite
	fill-token	"E86MWR"
	external-email	nil
	external-id	nil
	external-first-name	nil
	external-last-name	nil
	external-company	nil
	external-title	nil
	attendee-group-name	"Rich ppl"
	seat-count	0
attendee-group
	name	"Rich ppl"
	attendance-type	"in_person"
	default	false
	users-are-deletable	true
	attendees-count	0

Behavior

when using custom attendee group
- returns the created event invite object
when the request is successfull
- returns the created event invite object
- makes sure invite tokens are unique for each invite
when input data is invalid
- responds with status 422
when email invites reminders are enabled
- it automatically sends reminder emails

Get all invites

"curl -X GET -H 'Brella-API-Access-Token: OJZkMrtVH0lva92QajRf5RbqtzCOGpQ132MXAUnI' -H 'CONTENT_TYPE: application/json' https://api.brella.io/api/integration/organizations/2386/events/2395/invites"

{
  "data": [
    {
      "id": "2768",
      "type": "invite",
      "attributes": {
        "fill-token": "JOIN123",
        "external-email": "[email protected]",
        "external-id": "ID123",
        "external-first-name": "Mickey",
        "external-last-name": "Mouse",
        "external-company": "COM123",
        "external-title": "Retail Manager",
        "attendee-group-name": "Rich ppl",
        "seat-count": 1
      },
      "relationships": {
        "attendee-group": {
          "data": {
            "id": "6221",
            "type": "attendee-group"
          }
        },
        "seats": {
          "data": [
            {
              "id": "43124",
              "type": "seat"
            }
          ]
        },
        "question-responses": {
          "data": [

          ]
        }
      }
    },
    {
      "id": "2767",
      "type": "invite",
      "attributes": {
        "fill-token": "JOINONE",
        "external-email": "[email protected]",
        "external-id": "IDONE",
        "external-first-name": "Donald",
        "external-last-name": "Duck",
        "external-company": "",
        "external-title": "Mining Officer",
        "attendee-group-name": "Rich ppl",
        "seat-count": 1
      },
      "relationships": {
        "attendee-group": {
          "data": {
            "id": "6221",
            "type": "attendee-group"
          }
        },
        "seats": {
          "data": [
            {
              "id": "43123",
              "type": "seat"
            }
          ]
        },
        "question-responses": {
          "data": [
            {
              "id": "1143",
              "type": "question-response"
            }
          ]
        }
      }
    }
  ],
  "included": [
    {
      "id": "43124",
      "type": "seat",
      "attributes": {
        "token": "JOIN123"
      },
      "relationships": {
        "attendee": {
          "data": null
        }
      }
    },
    {
      "id": "6221",
      "type": "attendee-group",
      "attributes": {
        "name": "Rich ppl",
        "attendance-type": "in_person",
        "default": false,
        "users-are-deletable": true,
        "attendees-count": 0
      },
      "relationships": {
        "attendees": {
          "data": [

          ]
        }
      }
    },
    {
      "id": "43123",
      "type": "seat",
      "attributes": {
        "token": "JOINONE"
      },
      "relationships": {
        "attendee": {
          "data": null
        }
      }
    },
    {
      "id": "1143",
      "type": "question-response",
      "attributes": {
        "answers": [
          "a",
          "b",
          "c"
        ]
      }
    }
  ]
}

HTTP Request

GET /api/integration/organizations/:organization_id/events/:event_id/invites

Response

Type	Attribute	Example value
invite
	fill-token	"JOIN123"
	external-email	"[email protected]"
	external-id	"ID123"
	external-first-name	"Mickey"
	external-last-name	"Mouse"
	external-company	"COM123"
	external-title	"Retail Manager"
	attendee-group-name	"Rich ppl"
	seat-count	1
seat
seat	token	"JOIN123"
attendee-group
	name	"Rich ppl"
	attendance-type	"in_person"
	default	false
	users-are-deletable	true
	attendees-count	0
question-response
question-response	answers	["a", "b", "c"]

Behavior

when the request is successfull
- returns all invites for the event in an array

Get a specific invite

"curl -X GET -H 'Brella-API-Access-Token: hGqr5xtXdD5MhMPIZO0POu0Jvv71BsI8zgnQfmPj' -H 'CONTENT_TYPE: application/json' https://api.brella.io/api/integration/organizations/2388/events/2397/invites/2769"

{
  "data": {
    "id": "2769",
    "type": "invite",
    "attributes": {
      "fill-token": "JOINONE",
      "external-email": "[email protected]",
      "external-id": "IDONE",
      "external-first-name": "Donald",
      "external-last-name": "Duck",
      "external-company": "",
      "external-title": "Legacy Marketing Assistant",
      "attendee-group-name": "Rich ppl",
      "seat-count": 1
    },
    "relationships": {
      "attendee-group": {
        "data": {
          "id": "6226",
          "type": "attendee-group"
        }
      },
      "seats": {
        "data": [
          {
            "id": "43125",
            "type": "seat"
          }
        ]
      },
      "question-responses": {
        "data": [
          {
            "id": "1144",
            "type": "question-response"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "43125",
      "type": "seat",
      "attributes": {
        "token": "JOINONE"
      },
      "relationships": {
        "attendee": {
          "data": null
        }
      }
    },
    {
      "id": "6226",
      "type": "attendee-group",
      "attributes": {
        "name": "Rich ppl",
        "attendance-type": "in_person",
        "default": false,
        "users-are-deletable": true,
        "attendees-count": 0
      },
      "relationships": {
        "attendees": {
          "data": [

          ]
        }
      }
    },
    {
      "id": "1144",
      "type": "question-response",
      "attributes": {
        "answers": [
          "a",
          "b",
          "c"
        ]
      }
    }
  ]
}

HTTP Request

GET /api/integration/organizations/:organization_id/events/:event_id/invites/:id

Response

Type	Attribute	Example value
invite
	fill-token	"JOINONE"
	external-email	"[email protected]"
	external-id	"IDONE"
	external-first-name	"Donald"
	external-last-name	"Duck"
	external-company	""
	external-title	"Legacy Marketing Assistant"
	attendee-group-name	"Rich ppl"
	seat-count	1
seat
seat	token	"JOINONE"
attendee-group
	name	"Rich ppl"
	attendance-type	"in_person"
	default	false
	users-are-deletable	true
	attendees-count	0
question-response
question-response	answers	["a", "b", "c"]

Behavior

when the request is successfull
- returns an event invite object

Find invite

"curl -X GET -H 'Brella-API-Access-Token: scVV2KLVZgCsXXNoCfcOegANVYJInR87NxXaT8ET' -H 'CONTENT_TYPE: application/json' https://api.brella.io/api/integration/organizations/2390/events/2399/invites/find?external_email=invitee%40example.com"

{
  "data": {
    "id": "2771",
    "type": "invite",
    "attributes": {
      "fill-token": "JOINONE",
      "external-email": "[email protected]",
      "external-id": "IDONE",
      "external-first-name": "Donald",
      "external-last-name": "Duck",
      "external-company": "",
      "external-title": "Lead Construction Facilitator",
      "attendee-group-name": "Rich ppl",
      "seat-count": 1
    },
    "relationships": {
      "attendee-group": {
        "data": {
          "id": "6231",
          "type": "attendee-group"
        }
      },
      "seats": {
        "data": [
          {
            "id": "43127",
            "type": "seat"
          }
        ]
      },
      "question-responses": {
        "data": [
          {
            "id": "1145",
            "type": "question-response"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "43127",
      "type": "seat",
      "attributes": {
        "token": "JOINONE"
      },
      "relationships": {
        "attendee": {
          "data": null
        }
      }
    },
    {
      "id": "6231",
      "type": "attendee-group",
      "attributes": {
        "name": "Rich ppl",
        "attendance-type": "in_person",
        "default": false,
        "users-are-deletable": true,
        "attendees-count": 0
      },
      "relationships": {
        "attendees": {
          "data": [

          ]
        }
      }
    },
    {
      "id": "1145",
      "type": "question-response",
      "attributes": {
        "answers": [
          "a",
          "b",
          "c"
        ]
      }
    }
  ]
}

HTTP Request

GET /api/integration/organizations/:organization_id/events/:event_id/invites/find

Response

Type	Attribute	Example value
invite
	fill-token	"JOINONE"
	external-email	"[email protected]"
	external-id	"IDONE"
	external-first-name	"Donald"
	external-last-name	"Duck"
	external-company	""
	external-title	"Lead Construction Facilitator"
	attendee-group-name	"Rich ppl"
	seat-count	1
seat
seat	token	"JOINONE"
attendee-group
	name	"Rich ppl"
	attendance-type	"in_person"
	default	false
	users-are-deletable	true
	attendees-count	0
question-response
question-response	answers	["a", "b", "c"]

Behavior

when an event invite matching search terms is found
- returns an event invite object
when no results are found
- responds with an empty body
when no search params are provided
- returns status 400

Update a specific invite

"curl -X PUT -H 'Brella-API-Access-Token: xdaByN5Vi3UVOOCTEl52s5Fhd1XFTtsmyX2Y6BCT' -H 'CONTENT_TYPE: application/json' -d '{\"event_invite\":{\"external_email\":\"[email protected]\",\"seats\":15,\"attendee_group_id\":6249}}' https://api.brella.io/api/integration/organizations/2396/events/2405/invites/2777"

{
  "errors": [
    {
      "title": "Attendee group does not exist in the event.",
      "source": {
        "pointer": "/event_invite/attendee_group_id"
      }
    }
  ]
}

HTTP Request

PATCH /api/integration/organizations/:organization_id/events/:event_id/invites/:id

Request Parameters

Object	Attribute	Example value
event_invite	external_id	nil
	external_email	nil
	external_first_name	nil
	external_last_name	nil
	external_company	nil
	external_title	nil
	seats	nil
	attendee_group_id	nil
	import_id	nil

Response

Type	Attribute	Example value

Behavior

when using invalid attendee group
- returns with status 422 and an error message
when the request is successfull
- returns the update invite invite object
when email invites reminders are enabled
- it automatically sends reminder emails
when exceeding the maximum number of seats allowed per invite
- returns with status 422 and an error message

Remove a specific invite

"curl -X DELETE -H 'Brella-API-Access-Token: BtVOkL0VXzxYbMhQSfAoFCIcZjBD9vpGKjqxsCDO' -H 'CONTENT_TYPE: application/json' https://api.brella.io/api/integration/organizations/2404/events/2414/invites/2785"

{
  "data": {
    "id": "2785",
    "type": "invite",
    "attributes": {
      "fill-token": "JOINONE",
      "external-email": "[email protected]",
      "external-id": "IDONE",
      "external-first-name": "Donald",
      "external-last-name": "Duck",
      "external-company": "",
      "external-title": "Technology Technician",
      "attendee-group-name": "Rich ppl",
      "seat-count": 0
    },
    "relationships": {
      "attendee-group": {
        "data": {
          "id": "6269",
          "type": "attendee-group"
        }
      },
      "seats": {
        "data": [

        ]
      },
      "question-responses": {
        "data": [

        ]
      }
    }
  },
  "included": [
    {
      "id": "6269",
      "type": "attendee-group",
      "attributes": {
        "name": "Rich ppl",
        "attendance-type": "in_person",
        "default": false,
        "users-are-deletable": true,
        "attendees-count": 1
      },
      "relationships": {
        "attendees": {
          "data": [
            {
              "id": "1205",
              "type": "attendee"
            }
          ]
        }
      }
    }
  ]
}

HTTP Request

DELETE /api/integration/organizations/:organization_id/events/:event_id/invites/:id

Response

Type	Attribute	Example value
invite
	fill-token	"JOINONE"
	external-email	"[email protected]"
	external-id	"IDONE"
	external-first-name	"Donald"
	external-last-name	"Duck"
	external-company	""
	external-title	"Technology Technician"
	attendee-group-name	"Rich ppl"
	seat-count	0
attendee-group
	name	"Rich ppl"
	attendance-type	"in_person"
	default	false
	users-are-deletable	true
	attendees-count	1

Behavior

when the request is successfull
- delete the event invite and responds with an empty body

Events

Get all events

"curl -X GET -H 'Brella-API-Access-Token: 25UkeFvXGEAHMJgSmQIxxZIIZ2ZOTn0CM65P5230' -H 'CONTENT_TYPE: application/json' https://api.brella.io/api/integration/organizations/2315/events"

{
  "data": [
    {
      "id": "2356",
      "type": "event",
      "attributes": {
        "id": 2356,
        "name": "Veribet",
        "location": "",
        "address": "",
        "start-date": "2022-09-20",
        "end-date": "2022-09-21",
        "past": false,
        "table-nickname": "table",
        "infoarea-photo-url": "",
        "cover-photo-url": null,
        "logo-large-url": null,
        "logo-small-url": null,
        "uses-interests": false,
        "uses-timeslots": false,
        "uses-tables": true,
        "uses-sponsors": false,
        "uses-speakers": false,
        "event-type": "in_person",
        "uses-stream-link": false,
        "uses-meeting-slots": true,
        "uses-event-chat": false,
        "uses-timeslot-chat": false,
        "uses-wizard": true,
        "uses-ticketing": false,
        "industry": null,
        "city": null,
        "country": null,
        "region": null,
        "created-at": "2022-09-08T08:58:34.258Z",
        "content": null,
        "sponsors-name": "Partners",
        "primary-color": null,
        "secondary-color": null,
        "intent-pair-ids": null,
        "uses-reception-page": false,
        "launches-at": null,
        "start-time-utc": "2022-09-19T21:00:00.000Z",
        "end-time-utc": "2022-09-20T21:00:00.000Z",
        "chat-channel-id": null,
        "slug": "foobar",
        "external-chat-id": null,
        "time-zone": "Europe/Helsinki"
      },
      "relationships": {
        "tickets": {
          "data": [

          ]
        }
      }
    }
  ]
}

HTTP Request

GET /api/integration/organizations/:organization_id/events

Response

Type	Attribute	Example value
event
	id	2356
	name	"Veribet"
	location	""
	address	""
	start-date	"2022-09-20"
	end-date	"2022-09-21"
	past	false
	table-nickname	"table"
	infoarea-photo-url	""
	cover-photo-url	nil
	logo-large-url	nil
	logo-small-url	nil
	uses-interests	false
	uses-timeslots	false
	uses-tables	true
	uses-sponsors	false
	uses-speakers	false
	event-type	"in_person"
	uses-stream-link	false
	uses-meeting-slots	true
	uses-event-chat	false
	uses-timeslot-chat	false
	uses-wizard	true
	uses-ticketing	false
	industry	nil
	city	nil
	country	nil
	region	nil
	created-at	"2022-09-08T08:58:34.258Z"
	content	nil
	sponsors-name	"Partners"
	primary-color	nil
	secondary-color	nil
	intent-pair-ids	nil
	uses-reception-page	false
	launches-at	nil
	start-time-utc	"2022-09-19T21:00:00.000Z"
	end-time-utc	"2022-09-20T21:00:00.000Z"
	chat-channel-id	nil
	slug	"foobar"
	external-chat-id	nil
	time-zone	"Europe/Helsinki"

Behavior

when the request is successfull
- returns all events in the organization

Find event

"curl -X GET -H 'Brella-API-Access-Token: OyASI7e0BkJYtmuLRNJof5oM2nOqiB1W0ci5ZIGl' -H 'CONTENT_TYPE: application/json' https://api.brella.io/api/integration/organizations/2316/events/find?public_code=zedbaz"

{
  "data": null
}

HTTP Request

GET /api/integration/organizations/:organization_id/events/find

Response

Type	Attribute	Example value

Behavior

when no results are found
- responds with an empty body
when an event matching search terms is found
- returns an event object

Get a specific event

"curl -X GET -H 'Brella-API-Access-Token: DwERw1Tp0kyp6FHQ4LS7PMnzu4AlrxaCr5Apdhly' -H 'CONTENT_TYPE: application/json' https://api.brella.io/api/integration/organizations/2318/events/2359"

{
  "data": {
    "id": "2359",
    "type": "event",
    "attributes": {
      "id": 2359,
      "name": "Holdlamis",
      "location": "",
      "address": "",
      "start-date": "2022-09-17",
      "end-date": "2022-09-18",
      "past": false,
      "table-nickname": "table",
      "infoarea-photo-url": "",
      "cover-photo-url": null,
      "logo-large-url": null,
      "logo-small-url": null,
      "uses-interests": false,
      "uses-timeslots": false,
      "uses-tables": true,
      "uses-sponsors": false,
      "uses-speakers": false,
      "event-type": "in_person",
      "uses-stream-link": false,
      "uses-meeting-slots": true,
      "uses-event-chat": false,
      "uses-timeslot-chat": false,
      "uses-wizard": true,
      "uses-ticketing": false,
      "industry": null,
      "city": null,
      "country": null,
      "region": null,
      "created-at": "2022-09-08T08:58:34.542Z",
      "content": null,
      "sponsors-name": "Partners",
      "primary-color": null,
      "secondary-color": null,
      "intent-pair-ids": null,
      "uses-reception-page": false,
      "launches-at": null,
      "start-time-utc": "2022-09-16T21:00:00.000Z",
      "end-time-utc": "2022-09-17T21:00:00.000Z",
      "chat-channel-id": null,
      "slug": "foobar",
      "external-chat-id": null,
      "time-zone": "Europe/Helsinki"
    },
    "relationships": {
      "tickets": {
        "data": [

        ]
      }
    }
  }
}

HTTP Request

GET /api/integration/organizations/:organization_id/events/:id

Response

Type	Attribute	Example value
event
	id	2359
	name	"Holdlamis"
	location	""
	address	""
	start-date	"2022-09-17"
	end-date	"2022-09-18"
	past	false
	table-nickname	"table"
	infoarea-photo-url	""
	cover-photo-url	nil
	logo-large-url	nil
	logo-small-url	nil
	uses-interests	false
	uses-timeslots	false
	uses-tables	true
	uses-sponsors	false
	uses-speakers	false
	event-type	"in_person"
	uses-stream-link	false
	uses-meeting-slots	true
	uses-event-chat	false
	uses-timeslot-chat	false
	uses-wizard	true
	uses-ticketing	false
	industry	nil
	city	nil
	country	nil
	region	nil
	created-at	"2022-09-08T08:58:34.542Z"
	content	nil
	sponsors-name	"Partners"
	primary-color	nil
	secondary-color	nil
	intent-pair-ids	nil
	uses-reception-page	false
	launches-at	nil
	start-time-utc	"2022-09-16T21:00:00.000Z"
	end-time-utc	"2022-09-17T21:00:00.000Z"
	chat-channel-id	nil
	slug	"foobar"
	external-chat-id	nil
	time-zone	"Europe/Helsinki"

Behavior

when the request is successfull
- return an event object

Events Speakers

Get a specific speaker

"curl -X GET -H 'Brella-API-Access-Token: KPQPEmDNkzpRN5OUa8dxENBSsJdFIbH2OMVK7ISB' -H 'CONTENT_TYPE: application/json' https://api.brella.io/api/integration/organizations/2327/events/2368/speakers/1"

{
  "data": {
    "id": "1",
    "type": "speaker",
    "attributes": {
      "honorific": "Mrs.",
      "first-name": "Sal",
      "middle-name": null,
      "last-name": "Trantow",
      "job-title": "International Planner",
      "company-name": "Lemke Inc",
      "photo-url": null,
      "bio": {
        "blocks": [
          {
            "text": "[\"In sint molestias. Amet natus omnis. Eos qui modi.\", \"Sint fuga sed. Incidunt itaque consectetur. In nihil ipsum.\", \"Officiis iure necessitatibus. Quia autem accusantium. Harum hic ut.\"]",
            "type": "unstyled",
            "depth": 0,
            "entity-ranges": [

            ],
            "inline-style-ranges": [

            ]
          }
        ],
        "entity-map": {
        }
      },
      "highlight-position": null
    },
    "relationships": {
      "speaker-assignments": {
        "data": [

        ]
      }
    }
  },
  "included": [

  ]
}

HTTP Request

GET /api/integration/organizations/:organization_id/events/:event_id/speakers/:id

Response

Type	Attribute	Example value
speaker
	honorific	"Mrs."
	first-name	"Sal"
	middle-name	nil
	last-name	"Trantow"
	job-title	"International Planner"
	company-name	"Lemke Inc"
	photo-url	nil
	bio	{ "blocks": [ { "text": "[\"In sint molestias. Amet natus omnis. Eos qui modi.\", \"Sint fuga sed. Incidunt itaque consectetur. In nihil ipsum.\", \"Officiis iure necessitatibus. Quia autem accusantium. Harum hic ut.\"]", "type": "unstyled", "depth": 0, "entity-ranges": [ ], "inline-style-ranges": [ ] } ], "entity-map": { } }
	highlight-position	nil

Behavior

returns a speaker

Get all speakers

"curl -X GET -H 'Brella-API-Access-Token: jEykD3GrF3LH57VXcCn2fwUbXPCH3z3xLIrX9dt7' -H 'CONTENT_TYPE: application/json' https://api.brella.io/api/integration/organizations/2328/events/2369/speakers"

{
  "data": [
    {
      "id": "4",
      "type": "speaker",
      "attributes": {
        "honorific": "Mrs.",
        "first-name": "Shira",
        "middle-name": null,
        "last-name": "Veum",
        "job-title": "Chief Manager",
        "company-name": "Hoeger and Sons",
        "photo-url": null,
        "bio": {
          "blocks": [
            {
              "text": "[\"Voluptas unde nobis. Dolore aut vero. Vitae vero et.\", \"Ut recusandae dignissimos. Qui quidem cupiditate. Exercitationem et amet.\", \"Aliquam recusandae fugit. Eos voluptatem perspiciatis. Numquam aut eligendi.\"]",
              "type": "unstyled",
              "depth": 0,
              "entity-ranges": [

              ],
              "inline-style-ranges": [

              ]
            }
          ],
          "entity-map": {
          }
        },
        "highlight-position": null
      },
      "relationships": {
        "speaker-assignments": {
          "data": [

          ]
        }
      }
    },
    {
      "id": "3",
      "type": "speaker",
      "attributes": {
        "honorific": "Mrs.",
        "first-name": "Samatha",
        "middle-name": null,
        "last-name": "Nolan",
        "job-title": "Advertising Associate",
        "company-name": "Schaefer-Prohaska",
        "photo-url": null,
        "bio": {
          "blocks": [
            {
              "text": "[\"Nobis vel incidunt. Voluptatibus aut laboriosam. Placeat sit voluptatem.\", \"Aut voluptas praesentium. Dolores in repellendus. Distinctio iure iusto.\", \"Voluptate quaerat consequatur. Aut mollitia magnam. Labore beatae illo.\"]",
              "type": "unstyled",
              "depth": 0,
              "entity-ranges": [

              ],
              "inline-style-ranges": [

              ]
            }
          ],
          "entity-map": {
          }
        },
        "highlight-position": null
      },
      "relationships": {
        "speaker-assignments": {
          "data": [

          ]
        }
      }
    }
  ],
  "included": [

  ]
}

HTTP Request

GET /api/integration/organizations/:organization_id/events/:event_id/speakers

Response

Type	Attribute	Example value
speaker
	honorific	"Mrs."
	first-name	"Shira"
	middle-name	nil
	last-name	"Veum"
	job-title	"Chief Manager"
	company-name	"Hoeger and Sons"
	photo-url	nil
	bio	{ "blocks": [ { "text": "[\"Voluptas unde nobis. Dolore aut vero. Vitae vero et.\", \"Ut recusandae dignissimos. Qui quidem cupiditate. Exercitationem et amet.\", \"Aliquam recusandae fugit. Eos voluptatem perspiciatis. Numquam aut eligendi.\"]", "type": "unstyled", "depth": 0, "entity-ranges": [ ], "inline-style-ranges": [ ] } ], "entity-map": { } }
	highlight-position	nil

Behavior

returns a list of speakers

Remove a specific speaker

"curl -X DELETE -H 'Brella-API-Access-Token: bFvqxTMSlkKRL28NLYG9JfIeVG2DkVcp6xH6ucxO' -H 'CONTENT_TYPE: application/json' https://api.brella.io/api/integration/organizations/2329/events/2370/speakers/5"

{
  "data": {
    "id": "5",
    "type": "speaker",
    "attributes": {
      "honorific": "Mrs.",
      "first-name": "Dylan",
      "middle-name": null,
      "last-name": "Barton",
      "job-title": "Internal Director",
      "company-name": "Deckow-Heidenreich",
      "photo-url": null,
      "bio": {
        "blocks": [
          {
            "text": "[\"Veritatis voluptas qui. Sit qui quis. Impedit quia molestiae.\", \"Molestiae natus dolorem. Incidunt unde non. Est explicabo in.\", \"Quia ea sed. Reiciendis ipsam libero. Aliquam libero voluptate.\"]",
            "type": "unstyled",
            "depth": 0,
            "entity-ranges": [

            ],
            "inline-style-ranges": [

            ]
          }
        ],
        "entity-map": {
        }
      },
      "highlight-position": null
    },
    "relationships": {
      "speaker-assignments": {
        "data": [

        ]
      }
    }
  },
  "included": [

  ]
}

HTTP Request

DELETE /api/integration/organizations/:organization_id/events/:event_id/speakers/:id

Response

Type	Attribute	Example value
speaker
	honorific	"Mrs."
	first-name	"Dylan"
	middle-name	nil
	last-name	"Barton"
	job-title	"Internal Director"
	company-name	"Deckow-Heidenreich"
	photo-url	nil
	bio	{ "blocks": [ { "text": "[\"Veritatis voluptas qui. Sit qui quis. Impedit quia molestiae.\", \"Molestiae natus dolorem. Incidunt unde non. Est explicabo in.\", \"Quia ea sed. Reiciendis ipsam libero. Aliquam libero voluptate.\"]", "type": "unstyled", "depth": 0, "entity-ranges": [ ], "inline-style-ranges": [ ] } ], "entity-map": { } }
	highlight-position	nil

Behavior

deletes speaker

PUT /api/integration/organizations/:organization_id/events/:event_id/speakers/:id

"curl -X PUT -H 'Brella-API-Access-Token: 676lZTF2ujGigljfpB41hmtzan6xVf5x0tHuWYDP' -H 'CONTENT_TYPE: application/json' -d '{\"first_name\":\"new name\",\"photo\":\"https://fakeimg.pl/300/\",\"bio\":\"it's me\"}' https://api.brella.io/api/integration/organizations/2330/events/2371/speakers/7"

{
  "data": {
    "id": "7",
    "type": "speaker",
    "attributes": {
      "honorific": "Mrs.",
      "first-name": "new name",
      "middle-name": null,
      "last-name": "Thompson",
      "job-title": "Real-Estate Engineer",
      "company-name": "Jacobs-Mante",
      "photo-url": "/test/uploads/speaker/photo/7/d6759146ada7f.jpg",
      "bio": {
        "blocks": [
          {
            "text": "it's me",
            "type": "unstyled",
            "entity_ranges": [

            ]
          }
        ]
      },
      "highlight-position": null
    },
    "relationships": {
      "speaker-assignments": {
        "data": [

        ]
      }
    }
  },
  "included": [

  ]
}

HTTP Request

PUT /api/integration/organizations/:organization_id/events/:event_id/speakers/:id

Request Parameters

Object	Attribute	Example value
speaker	first_name	nil
	last_name	nil
	middle_name	nil
	job_title	nil
	honorific	nil
	company_name	nil
	photo	nil
	highlight_position	nil
	bio	nil

Response

Type	Attribute	Example value
speaker
	honorific	"Mrs."
	first-name	"new name"
	middle-name	nil
	last-name	"Thompson"
	job-title	"Real-Estate Engineer"
	company-name	"Jacobs-Mante"
	photo-url	"/test/uploads/speaker/photo/7/d6759146ada7f.jpg"
	bio	{ "blocks": [ { "text": "it's me", "type": "unstyled", "entity_ranges": [ ] } ] }
	highlight-position	nil

Behavior

updates a speaker
returns the speaker

Create a new speaker

"curl -X POST -H 'Brella-API-Access-Token: gSG2D31xZc8KIWAP1JvnRjxGFoF6RaRSm8EtonY8' -H 'CONTENT_TYPE: application/json' -d '{\"honorific\":\"Mrs.\",\"first_name\":\"Zenobia\",\"last_name\":\"McClure\",\"company_name\":\"Schmitt-Schneider\",\"job_title\":\"Legacy Assistant\",\"bio\":\"it's me\",\"highlight_position\":null,\"photo\":\"https://fakeimg.pl/300/\"}' https://api.brella.io/api/integration/organizations/2332/events/2373/speakers"

{
  "data": {
    "id": "13",
    "type": "speaker",
    "attributes": {
      "honorific": "Mrs.",
      "first-name": "Zenobia",
      "middle-name": null,
      "last-name": "McClure",
      "job-title": "Legacy Assistant",
      "company-name": "Schmitt-Schneider",
      "photo-url": "/test/uploads/speaker/photo/13/d6759146ada7f.jpg",
      "bio": {
        "blocks": [
          {
            "text": "it's me",
            "type": "unstyled",
            "entity_ranges": [

            ]
          }
        ]
      },
      "highlight-position": null
    },
    "relationships": {
      "speaker-assignments": {
        "data": [

        ]
      }
    }
  },
  "included": [

  ]
}

HTTP Request

POST /api/integration/organizations/:organization_id/events/:event_id/speakers

Request Parameters

Object	Attribute	Example value
speaker	first_name	nil
	last_name	nil
	middle_name	nil
	job_title	nil
	honorific	nil
	company_name	nil
	photo	nil
	highlight_position	nil
	bio	nil

Response

Type	Attribute	Example value
speaker
	honorific	"Mrs."
	first-name	"Zenobia"
	middle-name	nil
	last-name	"McClure"
	job-title	"Legacy Assistant"
	company-name	"Schmitt-Schneider"
	photo-url	"/test/uploads/speaker/photo/13/d6759146ada7f.jpg"
	bio	{ "blocks": [ { "text": "it's me", "type": "unstyled", "entity_ranges": [ ] } ] }
	highlight-position	nil

Behavior

returns the speaker
creates speaker

Events Sponsors

Get all sponsors

"curl -X GET -H 'Brella-API-Access-Token: Zw9Gd5zmJZnkwnunA2mpwc2EJjDnmiOR3cGMflpx' -H 'CONTENT_TYPE: application/json' https://api.brella.io/api/integration/organizations/2342/events/2375/sponsors"

{
  "data": [
    {
      "id": "1",
      "type": "sponsor",
      "attributes": {
        "name": "Rosenbaum and Sons",
        "order": 6,
        "logo-url": "",
        "cover-image-url": null,
        "website": null,
        "twitter": null,
        "linkedin": null,
        "facebook": null,
        "instagram": null,
        "subtitle": "expedite turn-key vortals",
        "industry": null,
        "position": 1,
        "content": null,
        "uses-chat": null,
        "cta-text": null,
        "uses-analytics": null,
        "lead-scanning-enabled": false,
        "has-automatic-representatives-linking": true,
        "chat-channel-id": null,
        "external-chat-id": null
      },
      "relationships": {
        "category": {
          "data": {
            "id": "1",
            "type": "sponsor-category"
          }
        },
        "attendees": {
          "data": [

          ]
        },
        "deck-media": {
          "data": [

          ]
        },
        "attachments": {
          "data": [

          ]
        },
        "tabs": {
          "data": [

          ]
        }
      }
    },
    {
      "id": "2",
      "type": "sponsor",
      "attributes": {
        "name": "Osinski-Kilback",
        "order": 1,
        "logo-url": "",
        "cover-image-url": null,
        "website": null,
        "twitter": null,
        "linkedin": null,
        "facebook": null,
        "instagram": null,
        "subtitle": "streamline back-end niches",
        "industry": null,
        "position": 1,
        "content": null,
        "uses-chat": null,
        "cta-text": null,
        "uses-analytics": null,
        "lead-scanning-enabled": false,
        "has-automatic-representatives-linking": true,
        "chat-channel-id": null,
        "external-chat-id": null
      },
      "relationships": {
        "category": {
          "data": {
            "id": "2",
            "type": "sponsor-category"
          }
        },
        "attendees": {
          "data": [

          ]
        },
        "deck-media": {
          "data": [

          ]
        },
        "attachments": {
          "data": [

          ]
        },
        "tabs": {
          "data": [

          ]
        }
      }
    },
    {
      "id": "3",
      "type": "sponsor",
      "attributes": {
        "name": "Green, Will and Rodriguez",
        "order": 6,
        "logo-url": "",
        "cover-image-url": null,
        "website": null,
        "twitter": null,
        "linkedin": null,
        "facebook": null,
        "instagram": null,
        "subtitle": "grow interactive infomediaries",
        "industry": null,
        "position": 1,
        "content": null,
        "uses-chat": null,
        "cta-text": null,
        "uses-analytics": null,
        "lead-scanning-enabled": false,
        "has-automatic-representatives-linking": true,
        "chat-channel-id": null,
        "external-chat-id": null
      },
      "relationships": {
        "category": {
          "data": {
            "id": "3",
            "type": "sponsor-category"
          }
        },
        "attendees": {
          "data": [

          ]
        },
        "deck-media": {
          "data": [

          ]
        },
        "attachments": {
          "data": [

          ]
        },
        "tabs": {
          "data": [

          ]
        }
      }
    }
  ],
  "included": [
    {
      "id": "1",
      "type": "sponsor-category",
      "attributes": {
        "level": "large",
        "name": "Herzog, Boehm and Braun",
        "position": 1,
        "sponsors-count": 1
      }
    },
    {
      "id": "2",
      "type": "sponsor-category",
      "attributes": {
        "level": "small",
        "name": "Corkery, Trantow and Kautzer",
        "position": 2,
        "sponsors-count": 1
      }
    },
    {
      "id": "3",
      "type": "sponsor-category",
      "attributes": {
        "level": "large",
        "name": "Hauck and Sons",
        "position": 3,
        "sponsors-count": 1
      }
    }
  ]
}

HTTP Request

GET /api/integration/organizations/:organization_id/events/:event_id/sponsors

Response

Type	Attribute	Example value
sponsor
	name	"Rosenbaum and Sons"
	order	6
	logo-url	""
	cover-image-url	nil
	website	nil
	twitter	nil
	linkedin	nil
	facebook	nil
	instagram	nil
	subtitle	"expedite turn-key vortals"
	industry	nil
	position	1
	content	nil
	uses-chat	nil
	cta-text	nil
	uses-analytics	nil
	lead-scanning-enabled	false
	has-automatic-representatives-linking	true
	chat-channel-id	nil
	external-chat-id	nil
sponsor-category
	level	"large"
	name	"Herzog, Boehm and Braun"
	position	1
	sponsors-count	1

Behavior

returns sponsors

"curl -X GET -H 'Brella-API-Access-Token: mQAO3oHAYdt6RDXEJMYbfjChKfG1aXfODKzQEu2n' -H 'CONTENT_TYPE: application/json' https://api.brella.io/api/integration/organizations/2343/events/2376/sponsors/4"

{
  "data": {
    "id": "4",
    "type": "sponsor",
    "attributes": {
      "name": "Hirthe-Bogisich",
      "order": 10,
      "logo-url": "",
      "cover-image-url": null,
      "website": null,
      "twitter": null,
      "linkedin": null,
      "facebook": null,
      "instagram": null,
      "subtitle": "monetize global web-readiness",
      "industry": null,
      "position": 1,
      "content": null,
      "uses-chat": null,
      "cta-text": null,
      "uses-analytics": null,
      "lead-scanning-enabled": false,
      "has-automatic-representatives-linking": true,
      "chat-channel-id": null,
      "external-chat-id": null
    },
    "relationships": {
      "category": {
        "data": {
          "id": "4",
          "type": "sponsor-category"
        }
      },
      "attendees": {
        "data": [

        ]
      },
      "deck-media": {
        "data": [

        ]
      },
      "attachments": {
        "data": [

        ]
      },
      "tabs": {
        "data": [

        ]
      }
    }
  },
  "included": [
    {
      "id": "4",
      "type": "sponsor-category",
      "attributes": {
        "level": "large",
        "name": "Smitham, Gislason and Armstrong",
        "position": 1,
        "sponsors-count": 1
      }
    }
  ]
}

HTTP Request

GET /api/integration/organizations/:organization_id/events/:event_id/sponsors/:id

Response

Type	Attribute	Example value
sponsor
	name	"Hirthe-Bogisich"
	order	10
	logo-url	""
	cover-image-url	nil
	website	nil
	twitter	nil
	linkedin	nil
	facebook	nil
	instagram	nil
	subtitle	"monetize global web-readiness"
	industry	nil
	position	1
	content	nil
	uses-chat	nil
	cta-text	nil
	uses-analytics	nil
	lead-scanning-enabled	false
	has-automatic-representatives-linking	true
	chat-channel-id	nil
	external-chat-id	nil
sponsor-category
	level	"large"
	name	"Smitham, Gislason and Armstrong"
	position	1
	sponsors-count	1

Behavior

returns a sponsor

"curl -X DELETE -H 'Brella-API-Access-Token: izGvRenE8yKs2elsWrcbyXLNogurIkIe4pC8yCF1' -H 'CONTENT_TYPE: application/json' https://api.brella.io/api/integration/organizations/2344/events/2377/sponsors/7"

{
  "data": {
    "id": "7",
    "type": "sponsor",
    "attributes": {
      "name": "Wuckert-Sipes",
      "order": 8,
      "logo-url": "",
      "cover-image-url": null,
      "website": null,
      "twitter": null,
      "linkedin": null,
      "facebook": null,
      "instagram": null,
      "subtitle": "synergize global users",
      "industry": null,
      "position": 1,
      "content": null,
      "uses-chat": null,
      "cta-text": null,
      "uses-analytics": null,
      "lead-scanning-enabled": false,
      "has-automatic-representatives-linking": true,
      "chat-channel-id": null,
      "external-chat-id": null
    },
    "relationships": {
      "category": {
        "data": {
          "id": "7",
          "type": "sponsor-category"
        }
      },
      "attendees": {
        "data": [

        ]
      },
      "deck-media": {
        "data": [

        ]
      },
      "attachments": {
        "data": [

        ]
      },
      "tabs": {
        "data": [

        ]
      }
    }
  },
  "included": [
    {
      "id": "7",
      "type": "sponsor-category",
      "attributes": {
        "level": "medium",
        "name": "Fisher, Graham and Adams",
        "position": 1,
        "sponsors-count": 0
      }
    }
  ]
}

HTTP Request

DELETE /api/integration/organizations/:organization_id/events/:event_id/sponsors/:id

Response

Type	Attribute	Example value
sponsor
	name	"Wuckert-Sipes"
	order	8
	logo-url	""
	cover-image-url	nil
	website	nil
	twitter	nil
	linkedin	nil
	facebook	nil
	instagram	nil
	subtitle	"synergize global users"
	industry	nil
	position	1
	content	nil
	uses-chat	nil
	cta-text	nil
	uses-analytics	nil
	lead-scanning-enabled	false
	has-automatic-representatives-linking	true
	chat-channel-id	nil
	external-chat-id	nil
sponsor-category
	level	"medium"
	name	"Fisher, Graham and Adams"
	position	1
	sponsors-count	0

Behavior

deletes a sponsor

PUT /api/integration/organizations/:organization_id/events/:event_id/sponsors/:id

"curl -X PUT -H 'Brella-API-Access-Token: sb86UUb506DAvIIVMR0RzeiUUtacVDmP1VnLqTFj' -H 'CONTENT_TYPE: application/json' -d '{\"name\":\"new Sponsor name\",\"cover_image\":\"https://fakeimg.pl/300/\"}' https://api.brella.io/api/integration/organizations/2345/events/2378/sponsors/10"

{
  "data": {
    "id": "10",
    "type": "sponsor",
    "attributes": {
      "name": "new Sponsor name",
      "order": 4,
      "logo-url": "",
      "cover-image-url": "/test/uploads/sponsors/sponsor/cover_image/10/d6759146ada7f.jpg",
      "website": null,
      "twitter": null,
      "linkedin": null,
      "facebook": null,
      "instagram": null,
      "subtitle": "utilize one-to-one interfaces",
      "industry": null,
      "position": 1,
      "content": null,
      "uses-chat": null,
      "cta-text": null,
      "uses-analytics": null,
      "lead-scanning-enabled": false,
      "has-automatic-representatives-linking": true,
      "chat-channel-id": null,
      "external-chat-id": null
    },
    "relationships": {
      "category": {
        "data": {
          "id": "10",
          "type": "sponsor-category"
        }
      },
      "attendees": {
        "data": [

        ]
      },
      "deck-media": {
        "data": [

        ]
      },
      "attachments": {
        "data": [

        ]
      },
      "tabs": {
        "data": [

        ]
      }
    }
  },
  "included": [
    {
      "id": "10",
      "type": "sponsor-category",
      "attributes": {
        "level": "small",
        "name": "Renner Group",
        "position": 1,
        "sponsors-count": 1
      }
    }
  ]
}

HTTP Request

PUT /api/integration/organizations/:organization_id/events/:event_id/sponsors/:id

Request Parameters

Object	Attribute	Example value
sponsor	category_id	nil
	position	nil
	uses_chat	nil
	uses_analytics	nil
	lead_scanning_enabled	nil
	name	nil
	logo	nil
	cover_image	nil
	cta_text	nil
	facebook	nil
	twitter	nil
	linkedin	nil
	instagram	nil
	website	nil
	subtitle	nil
	industry	nil
	has_automatic_representatives_linking	nil

Response

Type	Attribute	Example value
sponsor
	name	"new Sponsor name"
	order	4
	logo-url	""
	cover-image-url	"/test/uploads/sponsors/sponsor/cover_image/10/d6759146ada7f.jpg"
	website	nil
	twitter	nil
	linkedin	nil
	facebook	nil
	instagram	nil
	subtitle	"utilize one-to-one interfaces"
	industry	nil
	position	1
	content	nil
	uses-chat	nil
	cta-text	nil
	uses-analytics	nil
	lead-scanning-enabled	false
	has-automatic-representatives-linking	true
	chat-channel-id	nil
	external-chat-id	nil
sponsor-category
	level	"small"
	name	"Renner Group"
	position	1
	sponsors-count	1

Behavior

returns a sponsor
updates a sponsor

"curl -X POST -H 'Brella-API-Access-Token: qX5iuqoTzzl5ZzRSy0hAN6TUq9QokMjT1vFWW2Uq' -H 'CONTENT_TYPE: application/json' -d '{\"category_id\":19,\"name\":\"Sponsor\",\"cover_image\":\"https://fakeimg.pl/300/\"}' https://api.brella.io/api/integration/organizations/2347/events/2380/sponsors"

{
  "data": {
    "id": "19",
    "type": "sponsor",
    "attributes": {
      "name": "Sponsor",
      "order": null,
      "logo-url": "",
      "cover-image-url": "/test/uploads/sponsors/sponsor/cover_image/19/d6759146ada7f.jpg",
      "website": null,
      "twitter": null,
      "linkedin": null,
      "facebook": null,
      "instagram": null,
      "subtitle": null,
      "industry": null,
      "position": 1,
      "content": null,
      "uses-chat": null,
      "cta-text": null,
      "uses-analytics": null,
      "lead-scanning-enabled": false,
      "has-automatic-representatives-linking": true,
      "chat-channel-id": null,
      "external-chat-id": null
    },
    "relationships": {
      "category": {
        "data": {
          "id": "19",
          "type": "sponsor-category"
        }
      },
      "attendees": {
        "data": [

        ]
      },
      "deck-media": {
        "data": [

        ]
      },
      "attachments": {
        "data": [

        ]
      },
      "tabs": {
        "data": [

        ]
      }
    }
  },
  "included": [
    {
      "id": "19",
      "type": "sponsor-category",
      "attributes": {
        "level": "medium",
        "name": "Ledner, Bartell and Sporer",
        "position": 4,
        "sponsors-count": 1
      }
    }
  ]
}

HTTP Request

POST /api/integration/organizations/:organization_id/events/:event_id/sponsors

Request Parameters

Object	Attribute	Example value
sponsor	category_id	nil
	position	nil
	uses_chat	nil
	uses_analytics	nil
	lead_scanning_enabled	nil
	name	nil
	logo	nil
	cover_image	nil
	cta_text	nil
	facebook	nil
	twitter	nil
	linkedin	nil
	instagram	nil
	website	nil
	subtitle	nil
	industry	nil
	has_automatic_representatives_linking	nil

Response

Type	Attribute	Example value
sponsor
	name	"Sponsor"
	order	nil
	logo-url	""
	cover-image-url	"/test/uploads/sponsors/sponsor/cover_image/19/d6759146ada7f.jpg"
	website	nil
	twitter	nil
	linkedin	nil
	facebook	nil
	instagram	nil
	subtitle	nil
	industry	nil
	position	1
	content	nil
	uses-chat	nil
	cta-text	nil
	uses-analytics	nil
	lead-scanning-enabled	false
	has-automatic-representatives-linking	true
	chat-channel-id	nil
	external-chat-id	nil
sponsor-category
	level	"medium"
	name	"Ledner, Bartell and Sporer"
	position	4
	sponsors-count	1

Behavior

returns a sponsor
creates a sponsor
when industry param is not valid number
- does not create a sponsor
when category_id is not specified
- does not create a sponsor
when industry param is a number
- does not create a sponsor

Interests

Get a specific interest

"curl -X GET -H 'Brella-API-Access-Token: L4zXlOkSToiuBJ6IZE12QvwRIAQUMZ7uu4ufLC9R' -H 'CONTENT_TYPE: application/json' http://www.example.com/api/integration/organizations/2406/events/2416/interests/2"

{
  "data": {
    "id": "2",
    "type": "interest",
    "attributes": {
      "name": "Marketing",
      "position": 2,
      "event-id": 2416
    },
    "relationships": {
      "children": {
        "data": [
          {
            "id": "3",
            "type": "interest"
          },
          {
            "id": "4",
            "type": "interest"
          }
        ]
      },
      "intent-pairs": {
        "data": [

        ]
      }
    }
  },
  "included": [
    {
      "id": "3",
      "type": "interest",
      "attributes": {
        "name": "Copy writing",
        "position": 1,
        "event-id": 2416
      },
      "relationships": {
        "children": {
          "data": [

          ]
        },
        "intent-pairs": {
          "data": [

          ]
        }
      }
    },
    {
      "id": "4",
      "type": "interest",
      "attributes": {
        "name": "CRM",
        "position": 2,
        "event-id": 2416
      },
      "relationships": {
        "children": {
          "data": [

          ]
        },
        "intent-pairs": {
          "data": [

          ]
        }
      }
    }
  ]
}

HTTP Request

GET /api/integration/organizations/:organization_id/events/:event_id/interests/:id

Response

Type	Attribute	Example value
interest
	name	"Marketing"
	position	2
	event-id	2416

Behavior

when the request is successfull
- returns an interest object

Find interest

"curl -X GET -H 'Brella-API-Access-Token: I8yWsZLQsfqr88w1Dw26l9SDN4PhaipBTlumXfkj' -H 'CONTENT_TYPE: application/json' http://www.example.com/api/integration/organizations/2407/events/2417/interests/find?name_en=foo"

{
  "data": null
}

HTTP Request

GET /api/integration/organizations/:organization_id/events/:event_id/interests/find

Response

Type	Attribute	Example value

Behavior

when no results are found
- responds with an empty body
when an interest matching search terms is found
- returns an interest object

Get all interests

"curl -X GET -H 'Brella-API-Access-Token: OzJEOkbXmacRuhYpmcIu6AStGCkdhLzKDaA7Mn2M' -H 'CONTENT_TYPE: application/json' http://www.example.com/api/integration/organizations/2409/events/2419/interests"

{
  "data": [
    {
      "id": "13",
      "type": "interest",
      "attributes": {
        "name": "Design",
        "position": 1,
        "event-id": 2419
      },
      "relationships": {
        "children": {
          "data": [

          ]
        },
        "intent-pairs": {
          "data": [

          ]
        }
      }
    },
    {
      "id": "14",
      "type": "interest",
      "attributes": {
        "name": "Marketing",
        "position": 2,
        "event-id": 2419
      },
      "relationships": {
        "children": {
          "data": [
            {
              "id": "15",
              "type": "interest"
            },
            {
              "id": "16",
              "type": "interest"
            }
          ]
        },
        "intent-pairs": {
          "data": [

          ]
        }
      }
    }
  ],
  "included": [
    {
      "id": "15",
      "type": "interest",
      "attributes": {
        "name": "Copy writing",
        "position": 1,
        "event-id": 2419
      },
      "relationships": {
        "children": {
          "data": [

          ]
        },
        "intent-pairs": {
          "data": [

          ]
        }
      }
    },
    {
      "id": "16",
      "type": "interest",
      "attributes": {
        "name": "CRM",
        "position": 2,
        "event-id": 2419
      },
      "relationships": {
        "children": {
          "data": [

          ]
        },
        "intent-pairs": {
          "data": [

          ]
        }
      }
    }
  ]
}

HTTP Request

GET /api/integration/organizations/:organization_id/events/:event_id/interests

Response

Type	Attribute	Example value
interest
	name	"Design"
	position	1
	event-id	2419

Behavior

when the request is successfull
- returns all interests in the event as in an array

Memberships

Find membership

"curl -X GET -H 'Brella-API-Access-Token: kGo7WVBnpRpkWmibeiO4hWSQkJ54Uu7Qd97xrxsA' -H 'CONTENT_TYPE: application/json' https://api.brella.io/api/integration/organizations/2334/communities/16/memberships/find?email=shanellebogan%2Buser25%40example.com"

{
  "data": {
    "id": "9",
    "type": "membership",
    "attributes": {
      "id": 9,
      "first-name": "Shanelle",
      "last-name": "Bogan",
      "email": "[email protected]",
      "company-title": "Product Consulting Representative",
      "company-name": "Sipes, Kozey and Purdy",
      "created-at": "2022-09-08T08:58:35.933Z"
    },
    "relationships": {
      "community": {
        "data": {
          "id": "16",
          "type": "community"
        }
      }
    }
  }
}

HTTP Request

GET /api/integration/organizations/:organization_id/communities/:community_id/memberships/find

Response

Type	Attribute	Example value
membership
	id	9
	first-name	"Shanelle"
	last-name	"Bogan"
	email	"[email protected]"
	company-title	"Product Consulting Representative"
	company-name	"Sipes, Kozey and Purdy"
	created-at	"2022-09-08T08:58:35.933Z"

Behavior

when a membership matching search terms is found
- returns a membership object
when no results are found
- responds with an empty body

Get a specific membership

"curl -X GET -H 'Brella-API-Access-Token: NDDi0D7OYkjG3mCHlRfRHzo7DgkBIBHeTwGllPmM' -H 'CONTENT_TYPE: application/json' https://api.brella.io/api/integration/organizations/2336/communities/18/memberships/11"

{
  "data": {
    "id": "11",
    "type": "membership",
    "attributes": {
      "id": 11,
      "first-name": "Carlton",
      "last-name": "Kessler",
      "email": "[email protected]",
      "company-title": "Design Representative",
      "company-name": "Kautzer LLC",
      "created-at": "2022-09-08T08:58:36.064Z"
    },
    "relationships": {
      "community": {
        "data": {
          "id": "18",
          "type": "community"
        }
      }
    }
  }
}

HTTP Request

GET /api/integration/organizations/:organization_id/communities/:community_id/memberships/:id

Response

Type	Attribute	Example value
membership
	id	11
	first-name	"Carlton"
	last-name	"Kessler"
	email	"[email protected]"
	company-title	"Design Representative"
	company-name	"Kautzer LLC"
	created-at	"2022-09-08T08:58:36.064Z"

Behavior

when the request is successfull
- returns a membership object

Get all memberships

"curl -X GET -H 'Brella-API-Access-Token: HUVc8QDHNFkCpKZPuApoOUqJLH8USrHpsBbfayYC' -H 'CONTENT_TYPE: application/json' https://api.brella.io/api/integration/organizations/2337/communities/19/memberships"

{
  "data": [
    {
      "id": "12",
      "type": "membership",
      "attributes": {
        "id": 12,
        "first-name": "Son",
        "last-name": "Lang",
        "email": "[email protected]",
        "company-title": "Direct Sales Assistant",
        "company-name": "Bernhard-Stoltenberg",
        "created-at": "2022-09-08T08:58:36.117Z"
      },
      "relationships": {
        "community": {
          "data": {
            "id": "19",
            "type": "community"
          }
        }
      }
    }
  ]
}

HTTP Request

GET /api/integration/organizations/:organization_id/communities/:community_id/memberships

Response

Type	Attribute	Example value
membership
	id	12
	first-name	"Son"
	last-name	"Lang"
	email	"[email protected]"
	company-title	"Direct Sales Assistant"
	company-name	"Bernhard-Stoltenberg"
	created-at	"2022-09-08T08:58:36.117Z"

Behavior

when the request is successfull
- returns all memberships in the community

Ticket Purchases

Find ticket purchase

"curl -X GET -H 'Brella-API-Access-Token: rAEhuNcyl6PsL6n3ZVFMckJgLh9itVKIorlNOXhG' -H 'CONTENT_TYPE: application/json' https://api.brella.io/api/integration/organizations/2410/events/2420/ticket_purchases/find?purchasers_email=kenda%40walter.org"

{
  "data": {
    "id": "61ca0283-0905-423e-ae2c-f53d593949b3",
    "type": "ticket-purchase",
    "attributes": {
      "purchasers-email": "[email protected]",
      "first-name": "Kelley",
      "last-name": "Hettinger",
      "status": "draft",
      "created-at": "2022-09-08T08:58:40.901Z",
      "updated-at": "2022-09-08T08:58:40.901Z",
      "purchase-completed-at": null,
      "stripe-session-id": null
    },
    "relationships": {
      "event": {
        "data": {
          "id": "2420",
          "type": "event"
        }
      }
    }
  }
}

HTTP Request

GET /api/integration/organizations/:organization_id/events/:event_id/ticket_purchases/find

Response

Type	Attribute	Example value
ticket-purchase
	purchasers-email	"[email protected]"
	first-name	"Kelley"
	last-name	"Hettinger"
	status	"draft"
	created-at	"2022-09-08T08:58:40.901Z"
	updated-at	"2022-09-08T08:58:40.901Z"
	purchase-completed-at	nil
	stripe-session-id	nil

Behavior

when a ticket purchase matching search terms is found
- returns a ticket purchase object
when no results are found
- responds with an empty body

Get all ticket purchases

"curl -X GET -H 'Brella-API-Access-Token: LnCqfLyjAtKpS5YHLk0sgwWFfC16gKAQK9MTpbPV' -H 'CONTENT_TYPE: application/json' https://api.brella.io/api/integration/organizations/2412/events/2422/ticket_purchases"

{
  "data": [
    {
      "id": "f69b1e18-8609-4417-bc88-552cdaff7bb0",
      "type": "ticket-purchase",
      "attributes": {
        "purchasers-email": "[email protected]",
        "first-name": "Kelsi",
        "last-name": "Borer",
        "status": "draft",
        "created-at": "2022-09-08T08:58:41.069Z",
        "updated-at": "2022-09-08T08:58:41.069Z",
        "purchase-completed-at": null,
        "stripe-session-id": null
      },
      "relationships": {
        "event": {
          "data": {
            "id": "2422",
            "type": "event"
          }
        }
      }
    },
    {
      "id": "5c5178ab-562f-49f1-956e-a5623d3fa2ab",
      "type": "ticket-purchase",
      "attributes": {
        "purchasers-email": "[email protected]",
        "first-name": "Lang",
        "last-name": "Gusikowski",
        "status": "draft",
        "created-at": "2022-09-08T08:58:41.083Z",
        "updated-at": "2022-09-08T08:58:41.083Z",
        "purchase-completed-at": null,
        "stripe-session-id": null
      },
      "relationships": {
        "event": {
          "data": {
            "id": "2422",
            "type": "event"
          }
        }
      }
    }
  ]
}

HTTP Request

GET /api/integration/organizations/:organization_id/events/:event_id/ticket_purchases

Response

Type	Attribute	Example value
ticket-purchase
	purchasers-email	"[email protected]"
	first-name	"Kelsi"
	last-name	"Borer"
	status	"draft"
	created-at	"2022-09-08T08:58:41.069Z"
	updated-at	"2022-09-08T08:58:41.069Z"
	purchase-completed-at	nil
	stripe-session-id	nil

Behavior

when the request is successfull
- returns all ticket purchases in the event in an array

Get a specific ticket purchase

"curl -X GET -H 'Brella-API-Access-Token: GMJlT5WHBcMoSQKujglNI1teZ8nJS8A4riJpZs5M' -H 'CONTENT_TYPE: application/json' https://api.brella.io/api/integration/organizations/2413/events/2423/ticket_purchases/25c805bd-4828-4e1d-aab7-6c0d2b1dfc9f"

{
  "data": {
    "id": "25c805bd-4828-4e1d-aab7-6c0d2b1dfc9f",
    "type": "ticket-purchase",
    "attributes": {
      "purchasers-email": "[email protected]",
      "first-name": "Raymon",
      "last-name": "Hessel",
      "status": "draft",
      "created-at": "2022-09-08T08:58:41.153Z",
      "updated-at": "2022-09-08T08:58:41.153Z",
      "purchase-completed-at": null,
      "stripe-session-id": null
    },
    "relationships": {
      "event": {
        "data": {
          "id": "2423",
          "type": "event"
        }
      }
    }
  }
}

HTTP Request

GET /api/integration/organizations/:organization_id/events/:event_id/ticket_purchases/:id

Response

Type	Attribute	Example value
ticket-purchase
	purchasers-email	"[email protected]"
	first-name	"Raymon"
	last-name	"Hessel"
	status	"draft"
	created-at	"2022-09-08T08:58:41.153Z"
	updated-at	"2022-09-08T08:58:41.153Z"
	purchase-completed-at	nil
	stripe-session-id	nil

Behavior

when the request is successfull
- returns a ticket purchase object