Launch offer: 50% off.Paid plans only.See pricing
Skip to content
Lamba
Open menu
Get started

Documentation

Reference

OpenAPI and Postman

Export OpenAPI documents and use the Postman collection effectively.

OpenAPI endpoints

  • Platform API: GET /openapi/v1.json
  • BFF: GET /platform/openapi/v1.json

Availability can be restricted outside dev/local by admin gating.

Export OpenAPI as YAML

curl -fsS https://test.api.uselamba.com/openapi/v1.json -o openapi-platform.json
npx @redocly/cli@latest bundle openapi-platform.json -o openapi-platform.yml

curl -fsS https://test.api.uselamba.com/platform/openapi/v1.json -o openapi-bff.json
npx @redocly/cli@latest bundle openapi-bff.json -o openapi-bff.yml

Postman collection

  • Collection: backend/lamba/docs/contract/postman/lamba-bff.postman_collection.json
  • Environment: backend/lamba/docs/contract/postman/lamba-test.postman_environment.json

Recommended variables

  • baseUrl
  • accessToken
  • tenantId
  • projectId
  • autoLogin
  • autoRefresh

Suggested workflow

  1. Import collection and environment.
  2. Set baseUrl, tenantId, projectId.
  3. Enable autoRefresh for smoother protected route testing.
  4. Validate critical flows: auth, tenant/project, webhooks, limits.

Quality gates

  • Keep collection examples in sync with production contracts.
  • Include one happy-path and one error-path example for each critical endpoint group.
  • Use OpenAPI diff checks in CI for contract drift detection.

Related docs

  • API overview: /docs/reference/api-overview
  • Plan enforcement: /docs/concepts/plan-enforcement