docs / api v1
Build on Great Space.
APIs for moving flexible-workspace inventory in and out of Great Space: live availability for the
platforms that list it, and soon a way for providers to send it to us from their own systems.
- Base URL
-
https://api.greatspace.ai/v1 - Auth
-
Authorization: Bearer <token>
APIs
GET /v1/spaces Syndication API
For listing platforms and data partners. Pull live availability from every provider who
syndicates to you, shaped by your own export profiles.
Draft Coming soon Real-time Syndication
For listing platforms and data partners. A WebSocket that sends new and changed availability
the moment providers make the change, instead of waiting for the hourly snapshot.
Draft Coming soon Inventory API
For workspace providers. Keep buildings, units, availability and prices up to date straight
from your own systems, instead of a daily spreadsheet import.
The basics
- One host. Every API lives under
https://api.greatspace.ai/v1, over HTTPS only. - Access tokens. Create them in the app under Settings → Access tokens, one per integration, with only the scopes it needs. A token is shown once and can be revoked at any time.
- Names say what they hold. A field ending
Id, such asspaceId, takes one of our ids. One endingRef, such asunitRef, takes your own reference. A field with neither, such asproviders, accepts more than one kind, like an id or a Portal slug. - Errors are JSON. A failed call answers with
{ "success": false, "errorMessage": "…" }and acorrelationId. Quote it if you ask us about a request. - Versioned. Paths start
/v1, and the Syndication API also sends a schema version. Within a version we only add things, so ignore fields you don't recognise.
MCP and AI tools
To query a Portal from Claude, ChatGPT or another AI tool rather than from code, use the Portal MCP: a read-only connection with OAuth sign-in, so there's no token to manage.