UUpward API
v1

Getting started

Introduction

What the Upward public API does and how to reach it.

The Upward public API lets your platform create and manage Upward companies programmatically. Every endpoint is JSON over HTTPS and lives under /api/public/v1.

Base URL

https://www.upward.page/api/public/v1

Domain change

The main address is now upward.page. tryupward.page will remain online as a fallback for the previous system, so existing integrations keep working — point new integrations at upward.page.

https://www.tryupward.page/api/public/v1   # fallback, previous system

Conventions

  • All request and response bodies are JSON (content-type: application/json).
  • Timestamps are ISO 8601 in UTC.
  • Identifiers are UUIDs unless stated otherwise.
  • Errors always return an object with an `error` string, and `issues` when validation failed.