Skip to content

List a registration platform's events

GET/v1/organization/{orgId}/learning/workspace/meetings/sources/{appId}/events

US Region: https://public-api.sessionboard.com · EU Region: https://public-api-eu.sessionboard.com

The connected platform's events, newest first, each with the Sessionboard event it was already brought into (imported_event_id), so importing it again updates that event instead of making a second one. When the platform is not connected, connected is false and events is empty. Reads the platform; writes nothing. The token's user needs permission to view integrations. Requires read:learning; refused for a key restricted to particular events. Also at GET /v1/learning/workspace/meetings/sources/{appId}/events.

Request example

Terminal window
curl --request GET \
--url 'https://public-api.sessionboard.com/v1/organization/{orgId}/learning/workspace/meetings/sources/{appId}/events' \
--header 'x-access-token: <api-token>'

Try it

Authorization

Your token stays in this page. It is sent only to the region above and is never saved; it is gone when you leave or reload the page.

Path parameters
GET

Authorizations

  • x-access-tokenstringheader

    Organization API token. Generate from Organization Settings → API Tokens.

  • AuthorizationBearer <token>headeror

    OAuth 2.1 access token. Obtained via the OAuth PKCE flow at /oauth/token.

Send one of these. See Authentication.

Path parameters

  • orgIdstringpathrequired

    Your organization ID. Any other organization returns 404.

  • appIdstringpathrequired

    A registration platform. Today sessions can be brought in from cvent, swoogo and bizzabo; the others answer not_available (List registration platforms says why).

    Allowed values
    "cvent", "swoogo", "bizzabo", "rainfocus", "eventbrite", "swapcard", "visit", "map-your-show", "a2z"

Responses

200application/json

OK

  • successboolean
  • payloadLearningRemoteEventList
    Show child attributes
    • app_idstring

      A registration platform. Today sessions can be brought in from cvent, swoogo and bizzabo; the others answer not_available (List registration platforms says why).

      Allowed values
      "cvent", "swoogo", "bizzabo", "rainfocus", "eventbrite", "swapcard", "visit", "map-your-show", "a2z"
    • connectedboolean
    • supportedboolean

      Whether the platform can list events. Absent when not connected.

    • sourceLearningRegistrationSource
      Show child attributes
      • idstring

        A registration platform. Today sessions can be brought in from cvent, swoogo and bizzabo; the others answer not_available (List registration platforms says why).

        Allowed values
        "cvent", "swoogo", "bizzabo", "rainfocus", "eventbrite", "swapcard", "visit", "map-your-show", "a2z"
      • namestring
      • connectedboolean
      • connection_idstring | null
      • needs_reauthboolean
      • simulatedboolean
      • comingboolean

        Cannot be connected yet.

      • importableboolean

        Sessions can be brought in from it.

      • connectstring

        How a person connects it.

        Allowed values
        "oauth", "api_key", "coming"
      • bringsobject
        Show child attributes
        • sessionsLearningSourceBrings
          Show child attributes
          • availableboolean
          • notestring
        • speakersobject
          Show child attributes
          • availableboolean
          • notestring
          • on_sessionsboolean

            Speakers arrive on the sessions they present, so faculty carry over.

        • recordingsLearningSourceBrings
          Show child attributes
          • availableboolean
          • notestring
        • attendanceobject
          Show child attributes
          • availableboolean
          • notestring
          • needs_new_sign_inboolean

            The connection's sign-in cannot read attendees or check-ins.

      • linestring

        One line to show a person.

    • eventsLearningRemoteEvent[]
      Show child attributes
      • idstring

        The platform's event id.

      • namestring
      • starts_atstring | null
      • imported_event_idinteger | null

        The Sessionboard event it was brought into before.

      • imported_event_namestring | null

400application/json

A path, query or body value failed validation, or an unknown body property was sent. message names the field. (A source object naming the assistant, with the person's prompt, is accepted on every write and removed before validation.) For an {eventId} path that is not a whole number: error: VALIDATION_ERROR, eventId must be a valid integer.

Gateway errors carry error (a code) and message. Errors from Learning itself carry status, success: false, message, name, and sometimes code (and feature or paused_at).

  • errorstring | object

    The gateway's error code (SCOPE_REQUIRED, ORG_WIDE_TOKEN_REQUIRED, NOT_FOUND, …).

  • messagestring
  • statusinteger
  • successboolean
  • namestring
  • codestring

    FEATURE_NOT_ENABLED, AGENT_WRITES_PAUSED, …

  • featurestring
  • paused_atstring<date-time>

401

Missing, invalid or expired token.

403application/json

  • SCOPE_REQUIRED — the token lacks read:learning (reads) or write:learning (writes). Legacy tokens with no scopes cannot write.
  • ORG_WIDE_TOKEN_REQUIRED — the token is restricted to particular events: "Bringing in a meeting reaches the organization's registration platforms and every event, so this API key (restricted to particular events) cannot use it. Use a key without an event restriction."
  • FEATURE_NOT_ENABLED (feature: lessons_credits) — Learning is not on for the organization.
  • FORBIDDEN — the token's user is not an active member of the organization, lacks the Lessons permission, or (listing a platform's events, importing) lacks permission to view integrations (You need permission to view integrations to use Apps).

Gateway errors carry error (a code) and message. Errors from Learning itself carry status, success: false, message, name, and sometimes code (and feature or paused_at).

  • errorstring | object

    The gateway's error code (SCOPE_REQUIRED, ORG_WIDE_TOKEN_REQUIRED, NOT_FOUND, …).

  • messagestring
  • statusinteger
  • successboolean
  • namestring
  • codestring

    FEATURE_NOT_ENABLED, AGENT_WRITES_PAUSED, …

  • featurestring
  • paused_atstring<date-time>

404application/json

orgId is not your organization (error: NOT_FOUND, message: Organization not found).

Gateway errors carry error (a code) and message. Errors from Learning itself carry status, success: false, message, name, and sometimes code (and feature or paused_at).

  • errorstring | object

    The gateway's error code (SCOPE_REQUIRED, ORG_WIDE_TOKEN_REQUIRED, NOT_FOUND, …).

  • messagestring
  • statusinteger
  • successboolean
  • namestring
  • codestring

    FEATURE_NOT_ENABLED, AGENT_WRITES_PAUSED, …

  • featurestring
  • paused_atstring<date-time>

429application/json

  • The token's request limit (100 requests per 15 minutes per bucket by default — see Rate Limiting). Wait Retry-After seconds.
  • QUOTA_EXCEEDED (writes) — the token's daily write quota (10,000 a day). Resets at midnight UTC.

Gateway errors carry error (a code) and message. Errors from Learning itself carry status, success: false, message, name, and sometimes code (and feature or paused_at).

  • errorstring | object

    The gateway's error code (SCOPE_REQUIRED, ORG_WIDE_TOKEN_REQUIRED, NOT_FOUND, …).

  • messagestring
  • statusinteger
  • successboolean
  • namestring
  • codestring

    FEATURE_NOT_ENABLED, AGENT_WRITES_PAUSED, …

  • featurestring
  • paused_atstring<date-time>
  • Retry-Afterintegerheader

    Seconds to wait before retrying.

Response examples

{
"success": true,
"payload": {
"app_id": "cvent",
"connected": true,
"supported": true,
"source": {
"id": "cvent",
"name": "<string>",
"connected": true,
"connection_id": "<string>",
"needs_reauth": true,
"simulated": true,
"coming": true,
"importable": true,
"connect": "oauth",
"brings": {
"sessions": {
"available": true,
"note": "<string>"
},
"speakers": {
"available": true,
"note": "<string>",
"on_sessions": true
},
"recordings": {
"available": true,
"note": "<string>"
},
"attendance": {
"available": true,
"note": "<string>",
"needs_new_sign_in": true
}
},
"line": "<string>"
},
"events": [
{
"id": "<string>",
"name": "<string>",
"starts_at": "<string>",
"imported_event_id": 123,
"imported_event_name": "<string>"
}
]
}
}