Launch offer: 50% off.Paid plans only.See pricing
Skip to content

Documentation

Quickstart

API/BFF Quickstart

Call the Platform API and BFF with the required auth and tenant/project headers.


Overview

Use this guide to send your first authenticated request to Lamba surfaces:

  • Platform API base: /api/v1
  • BFF base: /platform

Prerequisites

  • Access token from a successful login flow
  • Valid tenantId and projectId
  • API base URL for your environment

1) Set base URL

# Production
LAMBA_API_BASE=https://api.uselamba.com

# Test
LAMBA_API_BASE=https://test.api.uselamba.com

2) Prepare required headers

Authorization: Bearer <access-token>
X-Tenant-Id: <tenant-guid>
X-Project-Id: <project-guid>
X-Correlation-Id: <uuid-optional>

3) Call a Platform endpoint

curl -X GET "$LAMBA_API_BASE/api/v1/platform/tenant" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "X-Tenant-Id: $TENANT_ID" \
  -H "X-Project-Id: $PROJECT_ID"

4) Call a BFF endpoint

curl -X GET "$LAMBA_API_BASE/platform/tenant/projects" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "X-Tenant-Id: $TENANT_ID" \
  -H "X-Project-Id: $PROJECT_ID"

5) Parse response patterns

  • Success wrapper: { data, isSuccess, message }
  • Error model: ProblemDetails with optional errorCode

6) Handle common failures

  • 401: refresh or restart authentication.
  • 403: validate role and tenant/project mapping.
  • 429: honor Retry-After with exponential backoff.
  • 402: treat as business-state (plan limit), not transient retry.

Next steps

  • API contract details: /docs/reference/api-overview
  • Error payloads: /docs/reference/errors
  • OpenAPI + Postman workflow: /docs/reference/openapi-postman

Next

Webhooks Quickstart
Register endpoints, verify signatures, and handle retries safely.