Get all events

curl --request GET \
  --url https://api.zuddl.com/v1/events \
  --header 'Authorization: <api-key>'

{
  "pagination": {
    "next": "/{apiEndpoint}?page=3",
    "current": "/{apiEndpoint}?page=2",
    "previous": "/{apiEndpoint}?page=1"
  },
  "data": [
    {
      "kind": "<string>",
      "url": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "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",
      "parentEventId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "location": {
        "venue": "<string>",
        "address": {
          "address": "<string>",
          "addressLine2": "<string>",
          "stateProvince": "<string>",
          "postalCode": "<string>",
          "country": "<string>"
        },
        "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",
      "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "updatedAt": "2025-04-11T12:30:00Z",
      "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "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"
        }
      ]
    }
  ]
}

GET

events

Get all events

curl --request GET \
  --url https://api.zuddl.com/v1/events \
  --header 'Authorization: <api-key>'

{
  "pagination": {
    "next": "/{apiEndpoint}?page=3",
    "current": "/{apiEndpoint}?page=2",
    "previous": "/{apiEndpoint}?page=1"
  },
  "data": [
    {
      "kind": "<string>",
      "url": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "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",
      "parentEventId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "location": {
        "venue": "<string>",
        "address": {
          "address": "<string>",
          "addressLine2": "<string>",
          "stateProvince": "<string>",
          "postalCode": "<string>",
          "country": "<string>"
        },
        "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",
      "createdBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "updatedAt": "2025-04-11T12:30:00Z",
      "updatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "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"
        }
      ]
    }
  ]
}

Authorizations

Authorization

string

header

required

Provide your API key secret in the Authorization header

Query Parameters

filter

string

Filter query in format:

Available filters:

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

sort

string

Sort query in format:

The following fields are sortable:

createdAt
endDate
name
startDate
updatedAt

page

number

Page number (default: 1)

size

number

Page size (default: 10, max: 50)

Response

List of events retrieved successfully

pagination

object

Show child attributes

pagination.next

string<uri>

URI of the next page. Also indicates the presence of a next page.

Example:

"/{apiEndpoint}?page=3"

pagination.current

string<uri>

URI of the current page.

Example:

"/{apiEndpoint}?page=2"

pagination.previous

string<uri>

URI of the previous page. Also indicates the presence of a previous page.

Example:

"/{apiEndpoint}?page=1"

data

object[]

Show child attributes

data.kind

string

data.url

string<uri>

data.id

string<uuid>

ID of the event

data.organizationId

string<uuid>

ID of the organization

data.name

string

Name of the event

Example:

"Huddle with zuddl."

data.teamName

string

TeamName of the event

Example:

"General"

data.description

string

Description of the event

Example:

"join us to learn more about zuddl."

data.identifier

string

Identifier of the event

Example:

"event-123"

data.startDate

string<date-time>

startDate of the event

Example:

"2025-04-11T12:30:00Z"

data.endDate

string<date-time>

endDate of the event

Example:

"2025-04-11T12:30:00Z"

data.timezone

string

Timezone of the event

Example:

"UTC/IST"

data.status

enum<string>

Status of the event

Available options:

UPCOMING,

ONGOING,

CANCELED,

COMPLETED

Example:

"UPCOMING/ONGOING"

data.type

enum<string>

Type of the event

Available options:

EVENT,

FIELD_EVENT,

WEBINAR,

THIRD_PARTY_EVENT

Example:

"WEBINAR/FIELD_EVENT/EVENT"

data.eventFormat

enum<string>

Format of the event

Available options:

VIRTUAL,

IN_PERSON,

HYBRID

Example:

"VIRTUAL/IN_PERSON/HYBRID"

data.websiteUrl

string

websiteUrl of the event

Example:

"https://app.zuddl.com/org/event"

data.parentEventId

string<uuid>

parentEventId of the event

data.location

object

location of the event

Show child attributes

data.location.venue

string

venue of the event

data.location.address

object

address of the event

Show child attributes

data.location.address.address

string

venue of the event

data.location.address.addressLine2

string

addressLine2 of the event

data.location.address.stateProvince

string

stateProvince of the event

data.location.address.postalCode

string

postalCode of the event

data.location.address.country

string

country of the event

data.location.coordinates

object

coordinates of the event

Show child attributes

data.location.coordinates.latitude

string

latitude of the event address

Example:

"24.4194509"

data.location.coordinates.longitude

string

longitude of the event

Example:

"27.4194509"

data.location.mapUrl

string

mapUrl of the event

Example:

"https://www.google.com/maps/place/?q=place_id:ChIJ_Q8bfYdGXj4Rz1s_sFHJqcA"

data.virtualEventUrl

string

virtualEventUrl of the event

Example:

"https://zuddl.com"

data.createdAt

string<date-time>

createdAt of the event

Example:

"2025-04-11T12:30:00Z"

data.createdBy

string<uuid>

createdBy of the event

data.updatedAt

string<date-time>

updatedAt of the event

Example:

"2025-04-11T12:30:00Z"

data.updatedBy

string<uuid>

updatedBy of the event

data.tags

object[]

Tags associated with the event

Show child attributes

data.tags.id

string

required

Unique identifier for the tag

Minimum string length: 1

Example:

"tag123"

data.tags.name

string

required

Name of the tag

Required string length: 2 - 60

Example:

"Marketing"

data.tags.color

string

Tag's own color or inherited from category

data.tags.categoryId

string

Category ID if tag belongs to a category

data.tags.categoryName

string

Category name

data.tags.categoryColor

string

Category color

data.tags.lastAppliedAt

string<date-time>

Last time tag was applied

data.tags.usageCount

integer<int32>

Number of times tag has been used

Example:

[
  {
    "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"
  }
]

Get attendee details

Get event details

⌘I

API Reference

APIs

Get all events

Authorizations

Query Parameters

Response