Sign in

v1

latestOpenAPI 3.1.02026-07-22285495.1 KB
Sessions

Get session details

Use this endpoint to retrieve the details of a specific session added to a particular event type in your Zuddl organization.

Required API key scopes: READ

get/v1/events/{eventId}/sessions/{sessionId}

Path parameters

eventIdstring required

Unique identifier of the event

sessionIdstring required

Unique identifier of the session

Response

Session details retrieved successfully

kindstring
urlstring uri
idstring uuid

Unique identifier of the session

titlestring

Name of the session

descriptionstring

Description of the session

startDateTimestring date-time

Start date time of the session

endDateTimestring date-time

End date time of the session

tagsstring[]

Tags of the session

availableSpotsinteger

Deprecated: use totalCapacity instead. Number of available spots for the session.

totalCapacityinteger

Total capacity configured for the session. Applies to in-person and hybrid sessions; null for virtual sessions.

remainingCapacityinteger

Number of spots still open for new registrations (totalCapacity minus already-registered users). Applies to in-person and hybrid sessions with a configured capacity; null otherwise.

externalRefIdstring

A reference ID that you can use to map this session to your external systems or databases

parentSessionIdstring

Parent session ID of the session

Example response

{
  "id": "d5e31ba5-2d1e-4918-bb60-dd1514b4b397",
  "title": "Maximize Your Potential: Strategies for Success in a Digital World",
  "description": "<p>Join us for an engaging online session designed to equip you with practical tools and insights for thriving in today's fast-paced, technology-driven environment.</p>",
  "startDateTime": "2025-03-14T05:55:00Z",
  "endDateTime": "2025-03-14T05:55:00Z",
  "location": [
    {
      "locationId": "d5e31ba5-2d1e-4918-bb60-dd1514b4b397",
      "locationName": "Session location"
    }
  ],
  "speakers": [
    {
      "speakerId": "d5e31ba5-2d1e-4918-bb60-dd1514b4b397"
    }
  ],
  "sponsors": [
    {
      "sponsorId": "d5e31ba5-2d1e-4918-bb60-dd1514b4b397"
    }
  ],
  "tags": [
    "tag1",
    "tag2"
  ],
  "files": [
    {
      "fileId": "d5e31ba5-2d1e-4918-bb60-dd1514b4b397",
      "fileName": "Presentation",
      "fileUrl": "https://phoenixlive.imgix.net/9807c938-413f-4a18-8f22-c3ac150f1e61"
    }
  ],
  "availableSpots": 100,
  "totalCapacity": 100,
  "remainingCapacity": 75,
  "externalRefId": "d812a64f8865428990249a120792c3d8",
  "parentSessionId": "d812a64f8865428990249a120792c3d8"
}