List events • Kommunity API Documentation

Retrieve a paginated list of events for the company associated with the API key.

Authorization

x-kommunity-api-key<token>

API key for authentication.

In: header

Query Parameters

limitinteger

Number of events to return per page

Default: 10Minimum: 1

offsetinteger

Number of events to skip for pagination

Default: 0Minimum: 0

beforestring

Filter events that start before this date (ISO 8601 format, e.g., '2024-12-31T23:59:59Z')

Format: "date-time"

afterstring

Filter events that start after this date (ISO 8601 format, e.g., '2024-01-01T00:00:00Z')

Format: "date-time"

includeAttendeesboolean

Include attendees in the response. If true, the 'attendees' field will be populated in each event object.

Default: false

Response Body

Successfully retrieved events

TypeScript Definitions

Use the response body type in TypeScript.

successboolean

Indicates if the API call was successful

dataobject

Unauthorized - Invalid or missing API key, or insufficient permissions

TypeScript Definitions

Use the response body type in TypeScript.

successboolean

Indicates that the request failed

Value in: false

errorstring

Error message describing what went wrong

detailsstring

Detailed information about the error (when available)

Server error

TypeScript Definitions

Use the response body type in TypeScript.

successboolean

Indicates that the request failed

Value in: false

errorstring

Error message describing what went wrong

detailsstring

Detailed information about the error (when available)

curl -X GET "/api/v1/events?limit=10&offset=0&before=2019-08-24T14%3A15%3A22Z&after=2019-08-24T14%3A15%3A22Z&includeAttendees=false" \
  -H "x-kommunity-api-key: <token>"

fetch("/api/v1/events?limit=10&offset=0&before=2019-08-24T14%3A15%3A22Z&after=2019-08-24T14%3A15%3A22Z&includeAttendees=false", {
  headers: {
    "x-kommunity-api-key": "<token>"
  }
})

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {
  url := "/api/v1/events?limit=10&offset=0&before=2019-08-24T14%3A15%3A22Z&after=2019-08-24T14%3A15%3A22Z&includeAttendees=false"

  req, _ := http.NewRequest("GET", url, nil)
  req.Header.Add("x-kommunity-api-key", "<token>")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}

import requests

url = "/api/v1/events?limit=10&offset=0&before=2019-08-24T14%3A15%3A22Z&after=2019-08-24T14%3A15%3A22Z&includeAttendees=false"

response = requests.request("GET", url, headers = {
  "x-kommunity-api-key": "<token>"
})

print(response.text)

{
  "success": true,
  "data": {
    "events": [
      {
        "name": "string",
        "description": "string",
        "category": "string",
        "subcategory": "string",
        "attendeeLimit": 1,
        "country": "string",
        "street": "string",
        "city": "string",
        "state": "string",
        "zipCode": "string",
        "eventImg": "string",
        "startTime": "string",
        "endTime": "string",
        "timezone": "string",
        "hostName": "string",
        "email": "string",
        "phone": "string",
        "tickets": [
          {
            "name": "string",
            "price": 0
          }
        ],
        "joinUrl": "http://example.com",
        "questions": [
          {
            "question": "string",
            "required": false
          }
        ],
        "attendees": [
          {
            "name": "string",
            "username": "string",
            "email": "string",
            "image": "string"
          }
        ],
        "crossPost": {
          "luma": false,
          "eventbrite": false,
          "meetup": false
        }
      }
    ],
    "pagination": {
      "total": 0,
      "limit": 0,
      "offset": 0,
      "hasMore": true
    }
  }
}

{
  "success": false,
  "error": "string",
  "details": "string"
}

{
  "success": false,
  "error": "string",
  "details": "string"
}