WePeopleDocs
IntegrationsPricingDocsSign inGet started
Get started
Docs home

Getting Started

  • What is WePeople
  • First week checklist
  • Core concepts

Product

  • Monitoring
  • Reports
  • People & profiles
  • SPACE scoring
  • Organization settings
  • Statistics
  • Billing & retention
  • Privacy model

Integrations

  • Overview
  • Slack
  • GitHub
  • Jira
  • Trust model

Developers

  • Platform overview
  • Quick start
  • Ingest guide
  • Custom statistics
  • Hosted MCP
  • TypeScript SDK

API Reference

  • Overview
  • Auth & headers
  • GET ping
  • POST events
  • POST snapshots
  • Apps statistics
  • Error codes
  • OpenAPI & SDK

Browse docs

API Reference

OpenAPI & SDK

The public contract is maintained as OpenAPI 3.1 YAML. The official TypeScript client is generated from the same spec and published as @wepeople/sdk.

OpenAPI spec

Canonical locations:

  • Production URL: https://wepeople.app/openapi/v1.yaml
  • Source repo: github.com/WEBX-PL/sdk-typescript/openapi
  • Versioned file: openapi/v1.yaml

Covers ingest endpoints (ping, events, snapshots) and app statistics (GET/PUT /api/v1/apps/statistics). Use it in Stoplight, Scalar, Redocly, or your own codegen pipeline.

Fetch specbash
curl -s "https://wepeople.app/openapi/v1.yaml" -o v1.yaml

TypeScript SDK

Package: @wepeople/sdk

Repository: github.com/WEBX-PL/sdk-typescript

installbash
npm install @wepeople/sdk

Usage guide: TypeScript SDK.

Code generation

Generate typed clients in other languages from the YAML:

openapi-typescriptbash
npx openapi-typescript https://wepeople.app/openapi/v1.yaml -o ./wepeople.d.ts

Or point your preferred OpenAPI generator (Fern, Speakeasy, openapi-generator) at the same URL.

Keeping in sync

The WePeople monorepo serves apps/web/public/openapi/v1.yaml. Any change to routes under apps/web/src/app/api/v1/** or Zod schemas in apps/web/src/lib/developer-api/ must mirror the YAML in the same PR.

The sdk-typescript repo regenerates npm types from that file — drift silently publishes wrong types to consumers.

Apps statistics

The statistic manifest endpoint (GET/PUT /api/v1/apps/statistics) is documented in these guides; extend the OpenAPI spec when the public contract changes.

On this page

  • OpenAPI spec
  • TypeScript SDK
  • Code generation
  • Keeping in sync
WePeople

Team insight, not surveillance. A lead's-eye view built on metadata from the tools your team already uses — never source code, never messages, never DMs.

Product

  • Monitoring & Reports
  • SPACE scoring
  • Pricing

Docs

  • Docs home
  • Getting started
  • Developer platform
  • API reference
  • MCP

Integrations

  • Browse integrations

Company

  • Support
  • Status

Legal

  • Brand
  • Privacy
  • Terms

© 2026 WePeople. Built with care.

Metadata only. No source code, no message bodies, no DMs — read the policy.