Skip to content
Karmo Developer Portal
Search
Ctrl
K
Cancel
Select theme
Dark
Light
Auto
Getting Started
Overview
Getting Started
API Reference (auto-generated)
auth-api
Overview
access-management
List known access-management permission slugs
Create or update an organization role
Delete an organization role
Replace role permissions
Create a user in the configured access provider
List users in the configured access provider for an organization
Get a user in the configured access provider
Update a user in the configured access provider
Get organization membership for user
Ensure membership exists for user in organization and assign roles
Update membership role for user in organization
Deactivate organization membership for user
Reactivate organization membership for user
health
Health check
well-known
Get JSON Web Key Set
OpenID Connect discovery document
token
Issue a service JWT (requires AWS_IAM auth)
bff-vouch
Overview
health
Health check
billing-accounts
Create a billing account for the current user
Get a billing account by id
Update a billing account
payment-methods
List the authenticated user's payment methods
Get a payment method by id
customer
Get a member by id (proxy to customer-api, requires member:read)
Update a member (proxy to customer-api, requires member:update)
Create a member (proxy to customer-api, requires member:create)
Get a member by mobile number (proxy to customer-api, requires member:read)
Update a member's license (proxy to customer-api, requires member:update)
Upsert a member's company (proxy to customer-api, requires member:update)
Upsert a member's address (proxy to customer-api, requires member:update)
Create a CRM payload for a member (proxy to customer-api, requires member:update)
Get an account by id (proxy to customer-api, requires account:read)
Update an account (proxy to customer-api, requires account:update)
Create an account (proxy to customer-api, requires account:create)
List members of an account (proxy to customer-api, requires account:read)
List accounts a member belongs to (proxy to customer-api, requires account:read)
Get the account owned by a member (proxy to customer-api, requires account:read)
Search accounts with filters and pagination (proxy to customer-api, requires account:search)
billing-account-api
Overview
Health
Overview
Health check
Payment Methods
Overview
Create a collection session
List all payment methods
Create a payment method
Get a payment method
Remove a payment method
Update a payment method
Billing Accounts
Overview
Create a billing account
Get a billing account
Update a billing account
Webhooks
Overview
Handle Stripe webhook events
customer-api
Overview
Account
Create a new account
Get account details
Update an account
Get accounts by member ID
Get owned account by member ID
List account members
Search accounts with filters and pagination (M2M only)
Health
Health check with database connectivity
Member
Create CRM payload for member
Create a new member
Get member details
Update a member
Get member by mobile number
Update license for member
Upsert address for member
Upsert company for member
Guides
Guides
Select theme
Dark
Light
Auto
Overview
Customer API (0.1.0)
Section titled “Customer API (0.1.0)”
Customer accounts and members service
OpenAPI version: 3.1.0