List events

/v1/companies/{campus}/events

A JSON page after since (a seq), or, with Accept: text/event-stream or ?stream=1, a live SSE feed: id: <seq>, event: <type>, data: <the row as JSON>, polled every 2 s, a : hb comment every 15 s of quiet, and resumable with Last-Event-ID. A feed that ends on a failure sends one event: error first.

Authorizations

Authorizationstringheaderrequired

Bearer token: Authorization: Bearer ozk_…. ozk_ platform API key (Authorization: Bearer ozk_…)

Path parameters

campusstringrequired

The company’s slug (plunge), never a row id

Query parameters

sinceinteger

Rows after this seq. On the live feed Last-Event-ID wins when both are sent

Default: 0

Required range: x >= 0

limitinteger

JSON page only: at most this many rows (the service default is 200)

Required range: 1 <= x <= 1000

streamenum<string>

Live SSE feed (the same as Accept: text/event-stream)

Available options: 1

formatenum<string>

Response format; overrides Accept (an unknown value is 400 invalid_format)

Available options: json, yaml, markdown, text

Response

Events after since, oldest first Response format negotiates via the format field, an Accept header (application/json, text/yaml, text/markdown, text/plain), or the request Content-Type mirror; default JSON. With Accept: text/event-stream or ?stream=1: an SSE stream of one event row per frame.

application/json
text/yaml
text/markdown
text/plain
text/event-stream

eventsobject[]

Show child attributes

seqinteger

Per company, dense, ascending: fold events in seq order

campusstring

buildingstring | null

item_idstring | null

officestring | null

typeenum<string>

Available options: item.created, step.enter, step.exit, run.start, run.end, desk.progress, handoff, approval.requested, approval.decided, item.parked, item.resumed, item.done, budget.warn, budget.stop, config.changed, building.connected, item.then, error

dataobject

References only, never bodies

atstring

head_seqinteger

invalid_format — format must be one of json, yaml, markdown, text

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

unauthorized — missing, invalid or revoked ozk_ key

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

company_not_found — no company with that slug for this account (a foreign slug answers the same); not_found — no route for this method on this path: every other method answers it

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

invalid_params — since or limit is not a whole number in range

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

upstream_error — the company service is unavailable; retry

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

not_enabled — the company service is not deployed on this tier

application/json

errorobjectrequired

Show child attributes

codestringrequired

messagestringrequired

connectobject

On a 424 connection_required / credential_required: where the missing connection is made.

Show child attributes

providerstring

methodenum<string>

Available options: oauth, api_key, wallet

linkstring

Example: "POST /v1/connections/stripe/link"

import os import requests response = requests.get( "https://api.plungeai.com/v1/companies/{campus}/events", headers={"Authorization": f"Bearer {os.environ['PLUNGE_API_KEY']}"}, ) if not response.ok: raise SystemExit(f"{response.status_code} {response.headers.get('X-Error-Code')}") print(response.json())

import os import requests with requests.get( "https://api.plungeai.com/v1/companies/{campus}/events", headers={"Authorization": f"Bearer {os.environ['PLUNGE_API_KEY']}"}, stream=True, ) as response: if not response.ok: raise SystemExit(f"{response.status_code} {response.headers.get('X-Error-Code')}") for line in response.iter_lines(): if line == b"data: [DONE]": break if line: print(line.decode())

const response = await fetch('https://api.plungeai.com/v1/companies/{campus}/events', { method: 'GET', headers: { Authorization: `Bearer ${process.env.PLUNGE_API_KEY}`, }, }) if (!response.ok) throw new Error(`${response.status} ${response.headers.get('X-Error-Code')}`) const reader = response.body!.getReader() const decoder = new TextDecoder() let buffer = '' read: while (true) { const { done, value } = await reader.read() if (done) break buffer += decoder.decode(value, { stream: true }) const frames = buffer.split('\n\n') buffer = frames.pop() ?? '' for (const frame of frames) { if (frame.trim() === 'data: [DONE]') break read console.log(frame) } }

import java.net.URI; import java.net.http.HttpClient; import java.net.http.HttpRequest; import java.net.http.HttpResponse; public class Main { public static void main(String[] args) throws Exception { HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://api.plungeai.com/v1/companies/{campus}/events")) .header("Authorization", "Bearer " + System.getenv("PLUNGE_API_KEY")) .GET() .build(); HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString()); if (response.statusCode() >= 400) { System.out.println(response.statusCode() + " " + response.headers().firstValue("X-Error-Code").orElse("")); return; } System.out.println(response.body()); } }

import java.net.URI; import java.net.http.HttpClient; import java.net.http.HttpRequest; import java.net.http.HttpResponse; public class Main { public static void main(String[] args) throws Exception { HttpClient client = HttpClient.newHttpClient(); HttpRequest request = HttpRequest.newBuilder() .uri(URI.create("https://api.plungeai.com/v1/companies/{campus}/events")) .header("Authorization", "Bearer " + System.getenv("PLUNGE_API_KEY")) .GET() .build(); HttpResponse<java.util.stream.Stream<String>> response = client.send(request, HttpResponse.BodyHandlers.ofLines()); if (response.statusCode() >= 400) { System.out.println(response.statusCode() + " " + response.headers().firstValue("X-Error-Code").orElse("")); return; } response.body().takeWhile(line -> !line.equals("data: [DONE]")).forEach(System.out::println); } }

{ "events": [ { "seq": 0, "campus": "<string>", "building": "<string>", "item_id": "<string>", "office": "<string>", "type": "item.created", "data": {}, "at": "<string>" } ], "head_seq": 0 }

Authorizations

Path parameters

Query parameters

Response

Planned: TI-33

Planned: TI-34