Get the event

Embed

<a href="https://forumulate.com/reference/forumulate-api-events-get"><img src="https://forumulate.com/reference/_api/public/orgs/046a9bc0-d530-43ae-9bae-af7945008cda/spaces/8042f004-e3d9-445f-b7a4-b6c1f86836e6/pages/675c96aa-ab97-42ba-8c96-6e8bc4fbc81e/social-card.svg?v=3e7ae33eec8b" alt="Get the event" width="600" height="315"></a>

GEThttps://forumulate.com/api/orgs/{orgId}/spaces/{spaceId}/events/{handle}

Requires token scope: read (the coarse method gate) for Atlas key (ak_), Personal Access Token (cft_) or OAuth (cfo_) auth — in addition to any catalog scope (GET /pats/scopes) the route’s capability needs. Session/cookie auth is governed by RBAC capabilities instead.

Parameters

orgIdstringpathrequired

spaceIdstringpathrequired

handlestringpathrequired

forumulate-versionstringheader

API version negotiation. Send forumulate-version: 2026-12-01 on every request from a new integration; it is optional only so that integrations written before versioning keep working. Each version includes everything before it:

Code samples

cURL

curl -X GET "https://forumulate.com/api/orgs/{orgId}/spaces/{spaceId}/events/{handle}" \
  -H "forumulate-version: <value>"

TypeScript

const res = await fetch('https://forumulate.com/api/orgs/{orgId}/spaces/{spaceId}/events/{handle}', {
  method: 'GET',
  headers: {
    'forumulate-version': '<value>',
  },
});
const data = await res.json();

Python

import requests

res = requests.request(
    "GET",
    "https://forumulate.com/api/orgs/{orgId}/spaces/{spaceId}/events/{handle}",
    headers={
    "forumulate-version": "<value>",
    },
)
data = res.json()

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://forumulate.com/api/orgs/{orgId}/spaces/{spaceId}/events/{handle}", nil)
	req.Header.Set("forumulate-version", "<value>")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}

PHP

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://forumulate.com/api/orgs/{orgId}/spaces/{spaceId}/events/{handle}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['forumulate-version: <value>']);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Ruby

require 'net/http'
require 'uri'

uri = URI('https://forumulate.com/api/orgs/{orgId}/spaces/{spaceId}/events/{handle}')
req = Net::HTTP::Get.new(uri)
req['forumulate-version'] = '<value>'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body

Java

import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://forumulate.com/api/orgs/{orgId}/spaces/{spaceId}/events/{handle}"))
    .header("forumulate-version", "<value>")
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Responses

200 Success.

Example

{
  "attendanceMode": "hybrid",
  "capacity": 0,
  "capacityState": {
    "capacity": 0,
    "full": true,
    "going": 0,
    "spotsLeft": 0,
    "waitlisted": 0,
    "waitlistOpen": true
  },
  "counts": {
    "declined": 0,
    "going": 0,
    "interested": 0,
    "waitlist": 0
  },
  "coverAlt": "string",
  "coverUrl": "string",
  "customization": {
    "customCss": "string",
    "jsonLd": "string",
    "ogDescription": "string",
    "ogTitle": "string",
    "shareImageUrl": "string",
    "theme": {
      "accentColor": "string",
      "bodyFontFamily": "string",
      "changelog": {
        "archive": null,
        "breakingBadge": null,
        "channelBadge": null,
        "closes": null,
        "columnWidth": null,
        "dateFormat": null,
        "datePlacement": null,
        "dateTone": null,
        "entry": null,
        "entryGap": null,
        "facts": null,
        "filters": null,
        "group": null,
        "gutter": null,
        "gutterWidth": null,
        "header": null,
        "indexWidth": null,
        "languages": null,
        "look": null,
        "prose": null,
        "rail": null,
        "release": null,
        "sections": null,
        "showTags": null,
        "stickyDate": null,
        "tagInk": null,
        "tagOverflow": null,
        "tagStyle": null,
        "typeBadge": null,
        "upgradeNotesFirst": null,
        "versionBadge": null,
        "widget": null
      },
      "colorScheme": "dark",
      "components": {
        "apiRef": null,
        "button": null,
        "buttonDark": null,
        "byline": null,
        "caption": null,
        "card": null,
        "code": null,
        "codeDark": null,
        "expandable": null,
        "focus": null,
        "hint": null,
        "image": null,
        "input": null,
        "inputDark": null,
        "kbd": null,
        "link": null,
        "list": null,
        "meta": null,
        "popover": null,
        "preview": null,
        "quote": null,
        "radius": null,
        "scrollbar": null,
        "select": null,
        "selection": null,
        "shadow": null,
        "skeleton": null,
        "spacing": null,
        "stepper": null,
        "syntax": null,
        "syntaxDark": null,
        "syntaxTheme": null,
        "table": null,
        "tabs": null
      },
      "contentWidth": "full",
      "customFontFamily": "string",
      "font": "mono",
      "headingFontFamily": "string",
      "layout": {
        "background": null,
        "canvas": null,
        "floatRoom": null,
        "frame": null,
        "guides": null,
        "gutter": null,
        "heroDecor": null,
        "indexHeader": null,
        "measure": null,
        "widths": null
      },
      "monoFontFamily": "string",
      "motion": {
        "ambient": null,
        "easing": null,
        "enabled": null,
        "header": null,
        "hover": null,
        "keyframes": null,
        "pageCrossfade": null,
        "pageTransition": null,
        "preset": null,
        "respectReducedMotion": null,
        "reveal": null,
        "scroll": null,
        "speed": null,
        "targets": null
      },
      "palette": {
        "background": null,
        "danger": null,
        "footer_background": null,
        "footer_primary": null,
        "header_background": null,
        "header_primary": null,
        "heading": null,
        "highlight": null,
        "info": null,
        "ink": null,
        "line": null,
        "love": null,
        "muted": null,
        "paper": null,
        "primary": null,
        "quaternary": null,
        "secondary": null,
        "success": null,
        "surface": null,
        "tertiary": null,
        "tint": null,
        "warning": null
      },
      "paletteDark": {
        "background": null,
        "danger": null,
        "footer_background": null,
        "footer_primary": null,
        "header_background": null,
        "header_primary": null,
        "heading": null,
        "highlight": null,
        "info": null,
        "ink": null,
        "line": null,
        "love": null,
        "muted": null,
        "paper": null,
        "primary": null,
        "quaternary": null,
        "secondary": null,
        "success": null,
        "surface": null,
        "tertiary": null,
        "tint": null,
        "warning": null
      },
      "post": {},
      "primaryColor": "string",
      "typography": {
        "baseSize": null,
        "bodyWrap": null,
        "features": null,
        "fluid": null,
        "headingTransform": null,
        "headingWrap": null,
        "levels": null,
        "numerals": null,
        "opticalSizing": null,
        "rhythm": null,
        "scale": null,
        "ui": null,
        "variation": null
      }
    },
    "twitterCard": "summary"
  },
  "description": "string",
  "endsAt": "string",
  "feedbackFormId": "string",
  "gallery": [
    {
      "alt": "string",
      "caption": "string",
      "url": "string"
    }
  ],
  "guestsMax": 0,
  "hostInfo": [
    {
      "author": "string",
      "avatarUrl": "string",
      "bio": "string",
      "handle": "string",
      "name": "string",
      "role": "string",
      "url": "string",
      "userId": "string"
    }
  ],
  "hosts": [
    {}
  ],
  "id": "string",
  "joinLinkHidden": true,
  "joinLinkVisibility": "attendees",
  "location": "string",
  "phase": "live",
  "previousStartsAt": "string",
  "questions": [
    {
      "help": "string",
      "label": "string",
      "max": 0,
      "min": 0,
      "name": "string",
      "options": [
        "string"
      ],
      "pattern": "string",
      "placeholder": "string",
      "required": true,
      "type": "checkbox",
      "value": "string"
    }
  ],
  "recapUrl": "string",
  "recordingUrl": "string",
  "recurrence": {
    "byWeekday": [
      "FR"
    ],
    "count": 0,
    "freq": "daily",
    "interval": 0,
    "until": "string"
  },
  "rrule": "string",
  "rsvpApproval": true,
  "sequence": 0,
  "seriesId": "string",
  "slidesUrl": "string",
  "slug": "string",
  "startsAt": "string",
  "state": "CANCELLED",
  "stateReason": "string",
  "tagInfo": [
    {
      "color": "string",
      "colorDark": "string",
      "coverUrl": "string",
      "description": "string",
      "gradient": [
        null
      ],
      "icon": "string",
      "label": "string",
      "pagePalette": {},
      "pageScheme": "dark",
      "slug": "string",
      "textColor": "string",
      "textColorDark": "string"
    }
  ],
  "tags": [
    "string"
  ],
  "timezone": "string",
  "title": "string",
  "topicId": "string",
  "updatedAt": "string",
  "url": "string",
  "venue": {
    "city": "string",
    "country": "string",
    "lat": 0,
    "lng": 0,
    "name": "string",
    "postalCode": "string",
    "region": "string",
    "street": "string"
  }
}

Schema

attendanceModestringrequired

hybrid | in_person | online

capacitynumberrequired

capacityStateobjectrequired

Show child parameters

capacitynumberrequired

fullbooleanrequired

goingnumberrequired

spotsLeftnumberrequired

waitlistednumberrequired

waitlistOpenbooleanrequired

countsobjectrequired

Show child parameters

declinednumberrequired

goingnumberrequired

interestednumberrequired

waitlistnumberrequired

coverAltstringrequired

coverUrlstringrequired

customizationPieceCustomizationrequired

Show child parameters

customCssstring

jsonLdstring

ogDescriptionstring

ogTitlestring

shareImageUrlstring

themeobject

Show child parameters

accentColorstring

bodyFontFamilystring

changelogobject

colorSchemestring

dark | light | system

componentsobject

contentWidthstring

full | standard | wide

customFontFamilystring

fontstring

mono | sans | serif

headingFontFamilystring

layoutobject

monoFontFamilystring

motionobject

paletteobject

paletteDarkobject

postobject

A structurally large type (a deeply nested or recursive union). Its full shape is served by the endpoint that produces it; GET /docs/block-schema covers the document block model.

primaryColorstring

typographyobject

twitterCardstring

summary | summary_large_image

descriptionstringrequired

endsAtstringrequired

feedbackFormIdstringrequired

galleryobject[]required

Show child parameters

altstring

captionstring

urlstringrequired

guestsMaxnumberrequired

hostInfoBylineView[]required

Show child parameters

authorstringrequired

avatarUrlstringrequired

biostringrequired

handlestring

namestringrequired

rolestringrequired

urlstringrequired

userIdstringrequired

hostsobject[]required

idstringrequired

joinLinkHiddenbooleanrequired

joinLinkVisibilitystringrequired

attendees | public

locationstringrequired

phasestringrequired

live | past | upcoming

previousStartsAtstringrequired

questionsFormField[]required

Show child parameters

helpstring

labelstringrequired

maxnumber

minnumber

namestringrequired

optionsstring[]

patternstring

placeholderstring

requiredboolean

typestringrequired

valuestring

recapUrlstringrequired

recordingUrlstringrequired

recurrenceobjectrequired

Show child parameters

byWeekdaystring[]

countnumber

freqstringrequired

daily | monthly | weekly

intervalnumber

untilstring

rrulestringrequired

rsvpApprovalbooleanrequired

sequencenumberrequired

seriesIdstringrequired

slidesUrlstringrequired

slugstringrequired

startsAtstringrequired

statestringrequired

CANCELLED | DRAFT | POSTPONED | PUBLISHED

stateReasonstringrequired

tagInfoTagDisplay[]required

Show child parameters

colorstringrequired

colorDarkstringrequired

coverUrlstringrequired

descriptionstringrequired

gradientarrayrequired

iconstring

labelstringrequired

pagePaletteobjectrequired

pageSchemestringrequired

dark | light

slugstringrequired

textColorstringrequired

textColorDarkstringrequired

tagsstring[]required

timezonestringrequired

titlestringrequired

topicIdstringrequired

updatedAtstringrequired

urlstringrequired

venueobjectrequired

Show child parameters

citystring

countrystring

latnumber

lngnumber

namestring

postalCodestring

regionstring

streetstring

400 The request could not be understood — a malformed header, path or query value (request.malformed). A value that was understood but is not acceptable is a 422 validation.failed.

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "docs": "string",
    "reason": "string",
    "slugs": [
      "string"
    ],
    "conflict": {
      "etag": "string",
      "ops": [
        null
      ]
    }
  },
  "requestId": "string"
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

Stable, machine-readable error code, e.g. rbac.forbidden.

messagestringrequired

Human-readable explanation.

detailsobject

Field-level validation problems, keyed by field path (422 only).

docsstring

Where the vocabulary or format this error is about is published — an absolute URL, or an API route such as GET /space-types/{type}/presets. Present on errors over a controlled list, so the answer to "what am I allowed to send?" is in the error itself.

reasonstring

Why a credential was refused, as one stable word, where one status has several causes — e.g. an external_jwt redeem answers iat_too_old, iat_in_future, bad_signature, bad_issuer, bad_audience, expired and more. Branch on this, not on message.

slugsstring[]

The exact slugs that collided, on a slug-conflict 409 — space.slug_taken, page.slug_taken, collection.slug_taken, site.slug_taken or badge.slug_taken.

conflictobject

On a 409 from a content entry field write (PATCH …/entries/{entryId}/fields) whose If-Match was stale.

Show child parameters

etagstringrequired

The entry's current fields etag.

opsarrayrequired

The field operations since your If-Match that touch a path your own operations touch. Empty: none did — retry the batch unchanged under etag. null: the history no longer reaches your tag — re-read the entry first.

requestIdstring

The id of this request — the same value as the x-request-id and x-forumulate-request-id response headers. Quote it in a bug report: it is the only thing that finds your exact request in our logs. It is in the body because that is the part that survives — an SDK that throws the parsed body, a serverless log that keeps the body and drops the headers, a ticket with the JSON pasted in.

401 No credential, or one that is expired or revoked (auth.required). Send a Bearer token or the session cookie.

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "docs": "string",
    "reason": "string",
    "slugs": [
      "string"
    ],
    "conflict": {
      "etag": "string",
      "ops": [
        null
      ]
    }
  },
  "requestId": "string"
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

Stable, machine-readable error code, e.g. rbac.forbidden.

messagestringrequired

Human-readable explanation.

detailsobject

Field-level validation problems, keyed by field path (422 only).

docsstring

reasonstring

slugsstring[]

The exact slugs that collided, on a slug-conflict 409 — space.slug_taken, page.slug_taken, collection.slug_taken, site.slug_taken or badge.slug_taken.

conflictobject

On a 409 from a content entry field write (PATCH …/entries/{entryId}/fields) whose If-Match was stale.

Show child parameters

etagstringrequired

The entry's current fields etag.

opsarrayrequired

requestIdstring

403 Authenticated, and not allowed — always rbac.forbidden, whether what is missing is the capability, the token scope, or a resource the token is pinned away from. The message names the capability and, for a scope refusal, the scopes that would grant it. A refusal because of the PLAN is a 402 with quota.exceeded, not this.

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "docs": "string",
    "reason": "string",
    "slugs": [
      "string"
    ],
    "conflict": {
      "etag": "string",
      "ops": [
        null
      ]
    }
  },
  "requestId": "string"
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

Stable, machine-readable error code, e.g. rbac.forbidden.

messagestringrequired

Human-readable explanation.

detailsobject

Field-level validation problems, keyed by field path (422 only).

docsstring

reasonstring

slugsstring[]

The exact slugs that collided, on a slug-conflict 409 — space.slug_taken, page.slug_taken, collection.slug_taken, site.slug_taken or badge.slug_taken.

conflictobject

On a 409 from a content entry field write (PATCH …/entries/{entryId}/fields) whose If-Match was stale.

Show child parameters

etagstringrequired

The entry's current fields etag.

opsarrayrequired

requestIdstring

404 No such thing — one of the ids in the path does not resolve, or resolves to something this caller may not see (*.not_found).

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "docs": "string",
    "reason": "string",
    "slugs": [
      "string"
    ],
    "conflict": {
      "etag": "string",
      "ops": [
        null
      ]
    }
  },
  "requestId": "string"
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

Stable, machine-readable error code, e.g. rbac.forbidden.

messagestringrequired

Human-readable explanation.

detailsobject

Field-level validation problems, keyed by field path (422 only).

docsstring

reasonstring

slugsstring[]

The exact slugs that collided, on a slug-conflict 409 — space.slug_taken, page.slug_taken, collection.slug_taken, site.slug_taken or badge.slug_taken.

conflictobject

On a 409 from a content entry field write (PATCH …/entries/{entryId}/fields) whose If-Match was stale.

Show child parameters

etagstringrequired

The entry's current fields etag.

opsarrayrequired

requestIdstring

429 Rate limited — see the RateLimit-* headers.

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "docs": "string",
    "reason": "string",
    "slugs": [
      "string"
    ],
    "conflict": {
      "etag": "string",
      "ops": [
        null
      ]
    }
  },
  "requestId": "string"
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

Stable, machine-readable error code, e.g. rbac.forbidden.

messagestringrequired

Human-readable explanation.

detailsobject

Field-level validation problems, keyed by field path (422 only).

docsstring

reasonstring

slugsstring[]

The exact slugs that collided, on a slug-conflict 409 — space.slug_taken, page.slug_taken, collection.slug_taken, site.slug_taken or badge.slug_taken.

conflictobject

On a 409 from a content entry field write (PATCH …/entries/{entryId}/fields) whose If-Match was stale.

Show child parameters

etagstringrequired

The entry's current fields etag.

opsarrayrequired

requestIdstring

default Error — the stable { error: { code, message } } envelope.

Example

{
  "error": {
    "code": "string",
    "message": "string",
    "details": {},
    "docs": "string",
    "reason": "string",
    "slugs": [
      "string"
    ],
    "conflict": {
      "etag": "string",
      "ops": [
        null
      ]
    }
  },
  "requestId": "string"
}

Schema

errorobjectrequired

Show child parameters

codestringrequired

Stable, machine-readable error code, e.g. rbac.forbidden.

messagestringrequired

Human-readable explanation.

detailsobject

Field-level validation problems, keyed by field path (422 only).

docsstring

reasonstring

slugsstring[]

The exact slugs that collided, on a slug-conflict 409 — space.slug_taken, page.slug_taken, collection.slug_taken, site.slug_taken or badge.slug_taken.

conflictobject

On a 409 from a content entry field write (PATCH …/entries/{entryId}/fields) whose If-Match was stale.

Show child parameters

etagstringrequired

The entry's current fields etag.

opsarrayrequired

requestIdstring

The Forumulate teamUpdated Oct 17, 2026

Was this page helpful?