List Partner Events

GET https://api.suger.cloud/ai/org/{orgId}/prm/event

List the partner events this organization runs and those shared with it by organizations whose partner program it belongs to. Each event has a `title`, a `type` (webinar, training, in_person, general), `startDatetime` and `endDatetime`, a `status` (draft, published, cancelled), who it is shared with (`visibilityType`: all, specific or tier) and, with RSVPs on, its `attendingCount`. Past events are included, and the default order is by start time, oldest first; send `s` as `-start_datetime` for the latest first. A call returns 10 rows unless `limit` says otherwise (at most 100; a larger `limit`, up to 1000, returns only 100 rows and sends `offset` to the wrong page, and one over 1000 is refused): page by sending `limit` on every call with `offset` a multiple of it (0, `limit`, twice `limit`,...) until you have `total_count` rows, and filter with `q`, such as `(= status "published")`. An event's `id` is the `eventId` GetPartnerEvent, UpdatePartnerEvent and ListPartnerEventRsvps take.

Parameters

NameInTypeRequiredDescription
orgId path string yes Organization ID
q query string no Filter: a LISP expression over the row's stored fields, written (= field "value"); combine conditions with (and...)
s query string no Sort field; prefix with - for descending
limit query integer no Rows to return (default 10, at most 100; a larger value, up to 1000, returns only 100 rows and sends `offset` to the wrong page; over 1000 is refused)
offset query integer no Rows to skip, a multiple of `limit` and sent together with it

Responses

200 — OK

Content-Type: application/json · Schema: ListBaseResponse-PartnerEventView

ListBaseResponse-PartnerEventView fields:

FieldTypeRequiredDescription
data array<PartnerEventView> no
page_number integer no
page_size integer no
total_count integer no TotalCount is the number of matching rows, counted up to ListCountCap. When TotalCountCapped is true it is that cap rather than the real total.
total_count_capped boolean no TotalCountCapped reports that more rows match than TotalCount says: the count stopped at ListCountCap because an exact total costs a full scan of everything the filter matches. Clients should present TotalCount as a lower bound ("10,000+") when this is set. Omitted when false, so clients that predate the field are unaffected.

PartnerEventView fields:

FieldTypeRequiredDescription
attendingCount integer no
capacity integer no Max attendees as a head count of attending partner_event_rsvp rows; NULL = uncapped. Only meaningful when is_rsvp_enabled=true — handler must reject capacity when RSVP is disabled and enforce the limit transactionally on write.
createTime string no Creation timestamp
creatorOrgName string no
description string no Freeform event description
endDatetime string no Event end (UTC)
id string no ID of the ent. Unique event identifier (UUID)
isRsvpEnabled boolean no Whether partners can RSVP to this event
lastUpdateTime string no Last update timestamp
location string no Freeform physical address/venue for in-person/hybrid events; NULL = online-only. Online vs in_person vs hybrid is derived from which of meeting_url/location are set.
meetingUrl string no Join link for online/hybrid events; NULL = no online component
organizationId string no Host ISV org that created the event (tenant isolation).
shareTargetIds array<string> no
startDatetime string no Event start (UTC)
status string no draft, published, cancelled. Lifecycle only — 'past' is computed from end_datetime, not stored.
timezone string no IANA tz name, e.g. America/Vancouver
title string no Event display name
type string no webinar, training, in_person, general.
viewerRsvpStatus string no
visibilityType string no all (every partner — no partner_event_visibility rows), specific (target_type=partner), tier (target_type=tier)

Example

Generated from this operation's schema. Values are placeholders — substitute your own ids, and set SUGER_TOKEN to a bearer token from the OAuth client-credentials exchange.

Request

curl -X GET 'https://api.suger.cloud/ai/org/{orgId}/prm/event' \
  -H "Authorization: Bearer $SUGER_TOKEN"

Response — 200

{
  "data": [
    {
      "attendingCount": 1,
      "capacity": 1,
      "createTime": "2026-01-31T12:00:00Z",
      "creatorOrgName": "Acme Corp",
      "description": "string",
      "endDatetime": "2026-01-31T12:00:00Z",
      "id": "01H0000000000000000000",
      "isRsvpEnabled": true,
      "lastUpdateTime": "2026-01-31T12:00:00Z",
      "location": "string",
      "meetingUrl": "https://example.com",
      "organizationId": "01H0000000000000000000"
    }
  ],
  "page_number": 1,
  "page_size": 1,
  "total_count": 1,
  "total_count_capped": true
}

View as Markdown · API reference overview

Spotted something wrong or out of date on this page? Tell us and we'll correct it.