TABLE OF CONTENTS

• 1. Overview
• 2. Use cases
  • Datacenter (region)-wise API endpoints: 
• 3. Authentication 
  • 3.1 Generate Access token & key
• 4. Event Series API's
  • 4.1 Listing of Event Series 
  • 4.2 Get all events of an Event Series
• 4. Points to keep in mind

1. Overview

Connect your Platform stack with Airmeet APIs and create events series.

2. Use cases

• Adding registrations to an event
• Adding speakers in bulk
• Creating sessions in bulk
• Creating booths in bulk
• Fetching attendance for the event, sessions, and booths for an event
• Fetching poll responses, questions asked for an event

Datacenter (region)-wise API endpoints: 

1. Use the "Default region" API if your community URL looks like this:

Default region (Mumbai): https://api-gateway.airmeet.com/prod

2. Use the "EU region" API if your community URL looks like this:

EU region: https://api-gateway-prod.eu.airmeet.com/prod

3. Use the "US region" API if your community URL looks like this:

US region: https://api-gateway-prod.us.airmeet.com/prod

Community dashboard: https://www.airmeet.com/ (use this to get a key pair issued).

3. Authentication 

3.1 Generate Access token & key

Step 1: Sign in to your airmeet account ( https://www.airmeet.com/signup )

Step 2: Click on the "Integrations" tab and select the "API Access Key" section.

Step 3: Click on "Generate access key" and provide a name/label to your key (can be anything that can be remembered later)

Step 4: After providing your label name 'X-Airmeet-Access-Key' with 'X-Airmeet-Secret-Key' would be generated, which can be used in API integration

Access Key = X-Airmeet-Access-Key

Secret Key = X-Airmeet-Secret-Key

All APIs expect a Content-Type: application/JSON header.

3.2 Authentication

POST /auth

This API issues a token for use with the other APIs mentioned in this doc.

Tokens issued by this API are valid for 30 days and can be cached on the consumer service.

Headers

X-Airmeet-Access-Key and X-Airmeet-Secret-Key (can be obtained over from the integrations tab in the community dashboard)

Response

200 OK {"success": true, "data": {"label": "test", "token":

<your_access_token>}}

400 Bad Request - in case the request is missing a header or the supplied values are incorrect

403 Forbidden - in case the keys are revoked (abuse prevention)

500 Internal Server Error - generic server error

4. Event Series API's

4.1 Listing of Event Series 

GET -/event-series

This API gives a list of all event-series in a community.

Endpoint:

GET /event-series

Headers:

X-Airmeet-Access-Token: airmeet_access_token 

Response:

200 OK - 

{

           "uid": "2bab3404-762f-4b9e-a259-d2dccdfe2b68",

           "description": "",

           "community_id": "edd55aa4-8edd-4605-ae7d-7eb02d798e9b",

           "name": "Airmeet QA - Event series 25Oct",

           "status": "CREATED",

           "created_at": "2023-10-25T05:53:00.183Z"

       },

       {

           "uid": "3cf9a3fc-2211-4953-8d57-a234f449e225",

           "description": "",

           "community_id": "edd55aa4-8edd-4605-ae7d-7eb02d798e9b",

           "name": "series prasad1",

           "status": "CREATED",

           "created_at": "2023-10-30T11:05:49.532Z"

       },

400 Bad Request - in case the passed token is bad
401 Unauthorized - in case the passed token does not have permission for the passed community_id

412 Precondition Failed - the passed access token has expired

500 Internal Server Error - generic server error

4.2 Get all events of an Event Series
GET - event-series/{eventSeriesId}/events
This api gives a list of all events inside the event series.

Endpoint:

GET event-series/{eventSeriesId}/events

Headers:

X-Airmeet-Access-Token: airmeet_access_token 

Response:

200 OK - 

{

   "uid": "7dd0d06e-d439-41fc-8e94-e1f52760bc19",

   "airmeets": [

       {

           "uid": "c05b2b80-2e4b-11ef-82f9-63ec4354c6e9",

           "name": "asdsad",

           "status": "CREATED",

           "eventType": "CONFERENCE",

           "event_sub_type": null,

           "startTime": "2024-06-22T15:00:00.000Z",

           "endTime": "2024-06-22T16:00:00.000Z",

           "timezone": "Asia/Kolkata",

           "timezoneAbbr": "IST",

           "hidden": false,

           "longDescription": null,

           "eventBannerUrl": "https://dy59fpv9tptwd.cloudfront.net/images/default-landing-banner-min.png",

           "is_archived": false,

           "post_event_access_enabled": true,

           "live_config": {},

           "meta": {

               "created_in_trial_plan": false,

               "defaultRegistrationForm": "v2",

               "post_event_entry_enabled_by_default": true

           }

       },

401 Unauthorized - in case the passed token does not have permission for the passed community_id

412 Precondition Failed - the passed access token has expired

500 Internal Server Error - generic server error

4. Points to keep in mind

• Tokens issued by this API are valid for 30 days and can be cached on the consumer service.
• Airmeet Event Series | FAQ's
  
  

Need more help? Contact [email protected] or visit our 24*7 Support Lounge.