Sign in

v1

latestOpenAPI 3.1.02026-07-22285495.1 KB
Events

Get event details

Use this endpoint to retrieve the details of a specific event, webinar, or field event created in your Zuddl organization.

Required API key scopes: READ

get/v1/events/{eventId}

Path parameters

eventIdstring required

Unique identifier of the event

Response

Event details retrieved successfully

kindstring
urlstring uri
idstring uuid

ID of the event

organizationIdstring uuid

ID of the organization

namestring

Name of the event

teamNamestring

TeamName of the event

descriptionstring

Description of the event

identifierstring

Identifier of the event

startDatestring date-time

startDate of the event

endDatestring date-time

endDate of the event

timezonestring

Timezone of the event

status'UPCOMING' | 'ONGOING' | 'CANCELED' | 'COMPLETED'

Status of the event

type'EVENT' | 'FIELD_EVENT' | 'WEBINAR' | 'THIRD_PARTY_EVENT'

Type of the event

eventFormat'VIRTUAL' | 'IN_PERSON' | 'HYBRID'

Format of the event

websiteUrlstring

websiteUrl of the event

parentEventIdstring uuid

parentEventId of the event

virtualEventUrlstring

virtualEventUrl of the event

createdAtstring date-time

createdAt of the event

createdBystring uuid

createdBy of the event

updatedAtstring date-time

updatedAt of the event

updatedBystring uuid

updatedBy of the event

Example response

{
  "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-14T12:30:00Z",
  "timezone": "UTC/IST",
  "status": "ONGOING/COMPLETED",
  "type": "WEBINAR/FIELD_EVENT/EVENT",
  "eventFormat": "VIRTUAL/IN_PERSON/HYBRID",
  "websiteUrl": "https://zuddl.com",
  "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"
    }
  ],
  "customProperties": [
    {
      "key": "salesforceCampaignId",
      "value": "ABCyyZ1234"
    }
  ]
}