Skip to main content

API Conventions

Base URL​

https://api-spaceos.zenspace.io/api/v1/

Versioning​

All endpoints use URI versioning: /api/v1/. The version is set via NestJS URI versioning with defaultVersion: '1'.

Response Envelope​

Every response follows this structure:

{
  "status": 200,
  "success": true,
  "message": "Optional human-readable message",
  "data": {},
  "timestamp": "2025-01-15T10:00:00.000Z",
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 100
  }
}

HTTP Methods​

MethodUsage
GETRead resources
POSTCreate resources
PATCHPartial update
PUTFull replacement (rare)
DELETERemove resources

Content Type​

All requests and responses use application/json.

Timestamps​

All timestamps are ISO-8601 in UTC: 2025-01-15T10:00:00.000Z

Organization Scoping​

Most list endpoints accept organization_id as a query parameter to scope results.

Next Steps​