Sign in

v1

latestOpenAPI 3.1.02026-07-22285495.1 KB
Events

Get all events

This endpoint returns the details of all events (all event types: webinar, field events, events) created by your Zuddl organization. You can use query parameters to filter and sort out the list, and pagination to show the list in an order.

Required API key scopes: READ

get/v1/events

Query parameters

filterstring

Filter query in format:

Available filters:

  • teamName: operations [eq]
  • endDate: operations [gt, lt, lte, between, gte, eq]
  • location.address.stateProvince: operations [in, eq]
  • type: operations [in, eq]
  • tags.name: operations [in, eq]
  • createdAt: operations [gt, lt, lte, between, gte, eq]
  • createdBy: operations [in, eq]
  • location.address.country: operations [in, eq]
  • name: operations [like, not_like]
  • parentEventId: operations [eq]
  • eventFormat: operations [in, eq]
  • startDate: operations [gt, lt, lte, between, gte, eq]
  • status: operations [in, eq]
sortstring

Sort query in format:

The following fields are sortable:

  • createdAt
  • endDate
  • name
  • startDate
  • updatedAt
pagenumber

Page number (default: 1)

sizenumber

Page size (default: 10, max: 50)

Response

List of events retrieved successfully

Example response

{
  "pagination": {
    "next": "/{apiEndpoint}?page=3",
    "current": "/{apiEndpoint}?page=2",
    "previous": "/{apiEndpoint}?page=1"
  },
  "data": [
    {
      "name": "Huddle with zuddl.",
      "teamName": "General",
      "description": "join us to learn more about zuddl.",
      "identifier": "event-123",
      "startDate": "2025-04-11T12:30:00Z",
      "endDate": "2025-04-11T12:30:00Z",
      "timezone": "UTC/IST",
      "status": "UPCOMING/ONGOING",
      "type": "WEBINAR/FIELD_EVENT/EVENT",
      "eventFormat": "VIRTUAL/IN_PERSON/HYBRID",
      "websiteUrl": "https://app.zuddl.com/org/event",
      "location": {
        "address": {
          "city": "San Francisco"
        },
        "coordinates": {
          "latitude": "24.4194509",
          "longitude": "27.4194509"
        },
        "mapUrl": "https://www.google.com/maps/place/?q=place_id:ChIJ_Q8bfYdGXj4Rz1s_sFHJqcA"
      },
      "virtualEventUrl": "https://zuddl.com",
      "createdAt": "2025-04-11T12:30:00Z",
      "updatedAt": "2025-04-11T12:30:00Z",
      "tags": [
        {
          "id": "tag1",
          "name": "Webinar",
          "color": "#AAFFEE",
          "categoryId": "category1",
          "categoryName": "Event type",
          "categoryColor": "#BBDDEE",
          "lastAppliedAt": "2025-09-01T06:31:35.711971Z",
          "usageCount": 2
        },
        {
          "id": "tag2",
          "name": "Field Event",
          "color": "#BBFFEE"
        }
      ]
    }
  ]
}