Keep Your Back Office. Connect Your Front Office.
A REST API, single-use login links and an AI-ready MCP endpoint connect your existing systems to every member's Bio/Profile Page, CRM, scheduling and follow-up.
Four ways to build on Upward
Get your API key
There are two kinds of key, depending on what you are building.
Company API key
For connecting your own systems to your company: sign members in, add members, and write to the CRM, scheduling and billing.
- Sign in as the company owner.
- Open Company Admin → API's.
- Copy your key and keep it on your server.
- Send it as
x-auth-tokenon every request.
One reusable key per company. Request a replacement from the same page if it is ever exposed.
Platform key
For back-office and partner platforms that create companies on behalf of their own customers.
- Contact the Upward team to request a platform key.
- Send it as
x-auth-keywhen you create companies. - Use the company key returned in the response for everything else.
Keys can be disabled, rotated or given an expiry date, and every request is logged against the key.
First request
Sign a member straight into their account with a single-use login link.
curl -X POST https://www.upward.page/api/public/v1/sso \ -H "x-auth-token: <company key>" \ -H "x-auth-user: jane-doe"
Always call the API from your backend, never from a browser or app.
Every endpoint
25 endpoints are live today. Each one has a full reference with fields, sample responses and a console where you can send a real request.
Vertical markets
Companies
Members
/create-memberCreate member. Create a team member under your company.x-auth-tokenPOST/ssoSSO (sign a member in). Sign one of your people straight into their back office with a single-use login link.x-auth-tokenGET/memberGet member. Read one member's details.x-auth-tokenPATCH/memberUpdate member. Update a member; only the fields you send are changed.x-auth-tokenGET/billing/plansList plans. The plans your company offers, with the plan_id to use in Set a plan.x-auth-tokenPOST/billing/subscriptionSet a plan. Record the plan someone bought in your own payment system.x-auth-tokenGET/billing/subscriptionRead a plan. The person's current plan, interval, dates, payment status and any scheduled change or cancellation.x-auth-tokenPOST/billing/cancelCancel a plan. End a plan now, or when the paid period runs out.x-auth-tokenBrand Kit
/brand-kit/offeringsCreate a product or service. Add a new product or service. It fails with 409 if the id is already used; use Update to change an existing one.x-auth-tokenPATCH/brand-kit/offerings/{id}Update a product or service. Change an existing product or service. Send only the fields that change.x-auth-tokenPOST/brand-kit/offerings/{id}/statusPublish, unpublish or archive. Change whether a product or service is live, by your id.x-auth-tokenGET/brand-kit/offerings/{id}Get a product or service. Read one product or service by your id.x-auth-tokenGET/brand-kit/offeringsList products and services. Read the company's Brand Kit products and services, one page at a time.x-auth-tokenGET/brand-kit/limitsPlan limits. The plan names and product/service limits for the company and for the plans it offers its members.x-auth-tokenCRM
/crm/create-meetingLog a meeting. Add a virtual or in-person meeting to a member's CRM calendar.x-auth-tokenPOST/crm/create-callLog a call. Schedule a phone call on a member's CRM calendar.x-auth-tokenPOST/crm/create-emailLog an email. Add an email activity to a member's CRM calendar.x-auth-tokenPOST/crm/create-smsLog a text message. Add a text-message activity — requires an active SMS Center number.x-auth-tokenPOST/create-leadCreate lead. Push a lead into a member's CRM pipeline.x-auth-tokenPOST/create-contactCreate contact. Create or update a CRM contact for a member.x-auth-tokenGET/crm-optionsCRM options. List pipeline stages, lead sources and every fixed CRM choice.x-auth-tokenScheduling
Coming next
/companies/{id}Get company. Read a single company, its branding and plan.PlannedGET/companiesList companies. Paginated list of the companies created with your key.PlannedPATCH/companies/{id}/brandingUpdate branding. Change logos and brand colours after creation.PlannedGET/companies/{id}/membersList members. Team members belonging to a company.PlannedGET/bookingsList bookings. Meetings booked through a company's scheduling pages.PlannedGuides and tools
Introduction
What the Upward public API does and how to reach it.
Quickstart
Create your first company in two calls.
API keys
How to authenticate requests with x-auth-key.
Error reference
Status codes returned by every endpoint.
Changelog
Versioned changes to the public API.
Bulk create members
Upload a CSV, map the columns and create many members at once. The import keeps running after you close the tab.
What teams build
Start in minutes
Company owners copy their API key in Company Admin → API's. Base URL: https://upward.page/api/public/v1
curl -X POST https://upward.page/api/public/v1/create-member \
-H "content-type: application/json" \
-H "x-auth-token: $UPWARD_API_KEY" \
-d '{
"first_name": "Jane",
"last_name": "Doe",
"email": "jane@example.com",
"pagename": "jane-doe",
"enroller_username": "robert",
"external_id": "BO-10482",
"send_welcome_email": true
}'
# Add a lead to Jane's CRM
curl -X POST https://upward.page/api/public/v1/create-lead \
-H "content-type: application/json" \
-H "x-auth-token: $UPWARD_API_KEY" \
-H "x-auth-user: jane-doe" \
-d '{ "name": "Sam Lee", "email_contacts": [{ "value": "sam@example.com" }], "lead_source": "Back office" }'Built-in integrations
Members connect these from their console — no code required.
Developer FAQ
Where do I get an API key?
Company owners copy their company key in Company Admin → API's. Platform and partner systems that create companies request a platform key from the Upward team. Keys are sent in a header and must be kept on your server.
Who can see the company key?
Only the company owner. If it may have been exposed, request a replacement from the same page; the current key keeps working until the new one is issued.
Does Upward replace my back office?
No. Your back office remains the system of record for enrollment, orders and commissions. Upward is the front office, and your systems send it members, leads and plan changes through the API.
Can members sign in from our portal?
Yes. Request a single-use login link for a member and send them straight into their Upward back office. Each link works once and expires after two minutes.
Can AI assistants use Upward?
Yes. The MCP endpoint lets AI assistants use Upward capabilities after OAuth authorization.
Is there a way to test calls?
Yes. Every endpoint in the documentation has a console where you add your key and send a real request.
Have a question about Developers?
Ask Vutesa, Upward's AI assistant — answers draw on this page's content.
Ready to turn every conversation into growth?
Start free, then replicate your system across your whole team.