mobitr.ee
Developers

Build on Mobitree with a clear API.

Ship profile experiences, links, campaigns, analytics, and team workflows with one documented REST contract that has a stable version path.

API version

v1 · Stable

The stable contract for new integrations. Breaking changes will ship under a new version.

Everything you need to integrate.

The reference below is rendered from the same OpenAPI contract that powers the MCP documentation tools.

67documented operations
JSONconsistent response envelope
v1stable version path

Start with the machine-readable contract.

Import openapi.json into your API client, then use the endpoint cards below for the human explanation and integration notes.

Authentication

Keep credentials in your server environment. Never expose a personal API key in browser code.

Personal API keys

Use a read-only key for inspection or an explicitly write-scoped key for mutations. Browser-session writes still require CSRF protection.

curl https://mobitr.ee/api/v1/profile \
  -H 'Authorization: Bearer <personal-api-key>'

API versions

Choose an explicit version so your integration stays predictable as Mobitree grows.

v1 · Stable

Current

The stable contract for new integrations. Breaking changes will ship under a new version.

https://mobitr.ee/api/v1

Legacy · Unversioned

Compatibility

The original unversioned base remains available while you migrate to /api/v1.

https://mobitr.ee/api

Endpoint reference

Browse every documented operation. Search by route, feature, method, or tag.

67 operations

Authentication

POST /api/v1/auth/register Public

Register a user

Create an account. Browser sessions require CSRF and accepted terms.

No auth required Responses: 200, 422 Request: RegisterRequest
View request and response details
ParametersNo path or query parameters
Responses200, 422
POST /api/v1/auth/login API key

Sign in

Authenticated Responses: 200, 202, 401 Request: LoginRequest
View request and response details
ParametersNo path or query parameters
Responses200, 202, 401
POST /api/v1/auth/2fa API key

Complete two-factor sign-in

Authenticated Responses: 200, 401 Request: object
View request and response details
ParametersNo path or query parameters
Responses200, 401
POST /api/v1/auth/logout API key

Sign out

Authenticated Responses: 200
View request and response details
ParametersNo path or query parameters
Responses200
POST /api/v1/auth/password-reset/request Public

Request a password reset

No auth required Responses: 200 Request: object
View request and response details
ParametersNo path or query parameters
Responses200
POST /api/v1/auth/password-reset/confirm Public

Confirm a password reset

No auth required Responses: 200, 422 Request: object
View request and response details
ParametersNo path or query parameters
Responses200, 422

Profile

GET /api/v1/profile API key

Get the current profile

Authenticated Responses: 200
View request and response details
ParametersNo path or query parameters
Responses200
PUT /api/v1/profile API key

Update public profile settings

Authenticated Responses: 200, 403 Request: ProfileUpdate
View request and response details
ParametersNo path or query parameters
Responses200, 403
POST /api/v1/profile/avatar API key

Replace the profile avatar

Authenticated Responses: 200, 422 Request: object
View request and response details
ParametersNo path or query parameters
Responses200, 422

Links

GET /api/v1/links API key

List profile links

Authenticated Responses: 200
View request and response details
Parameters2 documented parameter(s)
Responses200
POST /api/v1/links API key

Create a profile link

Authenticated Responses: 200, 422 Request: LinkWrite
View request and response details
ParametersNo path or query parameters
Responses200, 422
PUT /api/v1/links/{id} API key

Update a profile link

Authenticated Responses: 200, 409 Request: LinkWrite
View request and response details
ParametersNo path or query parameters
Responses200, 409
DELETE /api/v1/links/{id} API key

Archive a profile link

Authenticated Responses: 200
View request and response details
ParametersNo path or query parameters
Responses200
POST /api/v1/links/reorder API key

Reorder profile links

Authenticated Responses: 200 Request: object
View request and response details
ParametersNo path or query parameters
Responses200
POST /api/v1/business-blocks/upload API key

Upload a business-block asset

Authenticated Responses: 200, 422 Request: object
View request and response details
ParametersNo path or query parameters
Responses200, 422

Profile tools

GET /api/v1/profiles/{profile_id}/variants API key

List Dynamic Profile variants

Authenticated Responses: 200
View request and response details
ParametersNo path or query parameters
Responses200
POST /api/v1/profiles/{profile_id}/variants API key

Create a Dynamic Profile variant

Authenticated Responses: 200, 403
View request and response details
ParametersNo path or query parameters
Responses200, 403
PUT /api/v1/profiles/{profile_id}/variants/{variant_id} API key

Update a Dynamic Profile variant

Authenticated Responses: 200, 409
View request and response details
ParametersNo path or query parameters
Responses200, 409
DELETE /api/v1/profiles/{profile_id}/variants/{variant_id} API key

Archive a Dynamic Profile variant

Authenticated Responses: 200
View request and response details
ParametersNo path or query parameters
Responses200
GET /api/v1/profiles/{profile_id}/campaigns API key

List profile campaigns

Authenticated Responses: 200
View request and response details
ParametersNo path or query parameters
Responses200
POST /api/v1/profiles/{profile_id}/campaigns API key

Create a profile campaign

Authenticated Responses: 200, 403
View request and response details
ParametersNo path or query parameters
Responses200, 403
PUT /api/v1/profiles/{profile_id}/campaigns/{campaign_id} API key

Update a profile campaign

Authenticated Responses: 200, 409
View request and response details
ParametersNo path or query parameters
Responses200, 409
DELETE /api/v1/profiles/{profile_id}/campaigns/{campaign_id} API key

Archive a profile campaign

Authenticated Responses: 200
View request and response details
ParametersNo path or query parameters
Responses200
GET /api/v1/profiles/{profile_id}/versions API key

List profile versions

Authenticated Responses: 200
View request and response details
ParametersNo path or query parameters
Responses200
POST /api/v1/profiles/{profile_id}/versions API key

Create a named restore point

Authenticated Responses: 200
View request and response details
ParametersNo path or query parameters
Responses200
GET /api/v1/profiles/{profile_id}/versions/{version_id} API key

Review a profile version

Authenticated Responses: 200
View request and response details
ParametersNo path or query parameters
Responses200
DELETE /api/v1/profiles/{profile_id}/versions/{version_id} API key

Delete a profile version

Authenticated Responses: 200
View request and response details
ParametersNo path or query parameters
Responses200
POST /api/v1/profiles/{profile_id}/versions/{version_id}/restore API key

Restore a reviewed profile version

Authenticated Responses: 200, 409
View request and response details
ParametersNo path or query parameters
Responses200, 409
GET /api/v1/profiles/{profile_id}/doctor API key

Read Profile Doctor findings

Authenticated Responses: 200
View request and response details
ParametersNo path or query parameters
Responses200
POST /api/v1/profiles/{profile_id}/doctor/analyze API key

Run Profile Doctor analysis

Authenticated Responses: 200
View request and response details
ParametersNo path or query parameters
Responses200
POST /api/v1/profiles/{profile_id}/doctor/runs/{run_id}/recommendations/{recommendation_id}/apply API key

Apply a Profile Doctor recommendation

Authenticated Responses: 200, 409
View request and response details
ParametersNo path or query parameters
Responses200, 409
POST /api/v1/profiles/{profile_id}/doctor/actions/{action_id}/undo API key

Undo a Profile Doctor action

Authenticated Responses: 200, 409
View request and response details
ParametersNo path or query parameters
Responses200, 409
GET /api/v1/profiles/{profile_id}/ai-content API key

List saved AI content ideas

Authenticated Responses: 200
View request and response details
ParametersNo path or query parameters
Responses200
POST /api/v1/profiles/{profile_id}/ai-content/generate API key

Generate AI content suggestions

Authenticated Responses: 200
View request and response details
ParametersNo path or query parameters
Responses200
GET /api/v1/profiles/{profile_id}/smart-alerts API key

List smart alerts

Authenticated Responses: 200
View request and response details
ParametersNo path or query parameters
Responses200
PUT /api/v1/profiles/{profile_id}/smart-alerts/preferences API key

Update smart alert preferences

Authenticated Responses: 200
View request and response details
ParametersNo path or query parameters
Responses200
POST /api/v1/profiles/{profile_id}/smart-alerts/read API key

Mark smart alerts read

Authenticated Responses: 200
View request and response details
ParametersNo path or query parameters
Responses200
GET /api/v1/workspaces API key

List agency workspaces

Authenticated Responses: 200
View request and response details
ParametersNo path or query parameters
Responses200
POST /api/v1/workspaces API key

Create an agency workspace

Authenticated Responses: 201, 403
View request and response details
ParametersNo path or query parameters
Responses201, 403
GET /api/v1/workspaces/{workspace_id} API key

Get one agency workspace

Authenticated Responses: 200
View request and response details
ParametersNo path or query parameters
Responses200
PUT /api/v1/workspaces/{workspace_id} API key

Update an agency workspace

Authenticated Responses: 200, 409
View request and response details
ParametersNo path or query parameters
Responses200, 409
DELETE /api/v1/workspaces/{workspace_id} API key

Archive an agency workspace

Authenticated Responses: 200
View request and response details
ParametersNo path or query parameters
Responses200
PUT /api/v1/workspaces/{workspace_id}/profiles API key

Set profiles assigned to a workspace

Authenticated Responses: 200
View request and response details
ParametersNo path or query parameters
Responses200
GET /api/v1/workspaces/{workspace_id}/summary API key

Get workspace summary

Authenticated Responses: 200
View request and response details
ParametersNo path or query parameters
Responses200
POST /api/v1/workspaces/{workspace_id}/invites API key

Invite a workspace collaborator

Authenticated Responses: 201
View request and response details
ParametersNo path or query parameters
Responses201
PUT /api/v1/workspaces/{workspace_id}/members/{member_id} API key

Update a workspace collaborator

Authenticated Responses: 200
View request and response details
ParametersNo path or query parameters
Responses200
DELETE /api/v1/workspaces/{workspace_id}/members/{member_id} API key

Remove a workspace collaborator

Authenticated Responses: 200
View request and response details
ParametersNo path or query parameters
Responses200
POST /api/v1/workspaces/{workspace_id}/transfers API key

Request profile ownership transfer

Authenticated Responses: 201
View request and response details
ParametersNo path or query parameters
Responses201
DELETE /api/v1/workspaces/{workspace_id}/transfers/{transfer_id} API key

Cancel a pending ownership transfer

Authenticated Responses: 200
View request and response details
ParametersNo path or query parameters
Responses200
GET /api/v1/forms/submissions API key

List profile form submissions

Authenticated Responses: 200
View request and response details
Parameters3 documented parameter(s)
Responses200
GET /api/v1/forms/{form_id}/submissions API key

List submissions for one form

Authenticated Responses: 200
View request and response details
Parameters3 documented parameter(s)
Responses200

Billing

GET /api/v1/billing/plans Public

List available plans

No auth required Responses: 200
View request and response details
ParametersNo path or query parameters
Responses200
POST /api/v1/billing/checkout API key

Create a billing checkout session

Authenticated Responses: 200
View request and response details
ParametersNo path or query parameters
Responses200
POST /api/v1/billing/portal API key

Create a customer portal session

Authenticated Responses: 200
View request and response details
ParametersNo path or query parameters
Responses200
POST /api/v1/billing/customer-portal API key

Create a customer portal session (alias)

Authenticated Responses: 200
View request and response details
ParametersNo path or query parameters
Responses200
POST /api/v1/billing/apply-voucher API key

Apply a billing voucher

Authenticated Responses: 200, 422
View request and response details
ParametersNo path or query parameters
Responses200, 422

Analytics

GET /api/v1/analytics/overview API key

Read profile analytics overview

Authenticated Responses: 200
View request and response details
Parameters2 documented parameter(s)
Responses200
GET /api/v1/analytics/heatmaps API key

Read interaction heatmaps

Authenticated Responses: 200
View request and response details
ParametersNo path or query parameters
Responses200
GET /api/v1/analytics/variants API key

Read Dynamic Profile analytics

Authenticated Responses: 200
View request and response details
ParametersNo path or query parameters
Responses200
GET /api/v1/analytics/campaigns API key

Read campaign analytics

Authenticated Responses: 200
View request and response details
ParametersNo path or query parameters
Responses200
GET /api/v1/analytics/links API key

Read link analytics

Authenticated Responses: 200
View request and response details
Parameters2 documented parameter(s)
Responses200

Administration

GET /api/v1/admin/users API key

List users for platform administration

Authenticated Responses: 200, 401
View request and response details
ParametersNo path or query parameters
Responses200, 401
PUT /api/v1/admin/users/{id}/block API key

Block a user

Authenticated Responses: 200
View request and response details
ParametersNo path or query parameters
Responses200
PUT /api/v1/admin/users/{id}/unblock API key

Unblock a user

Authenticated Responses: 200
View request and response details
ParametersNo path or query parameters
Responses200
GET /api/v1/admin/profiles API key

List profiles for platform administration

Authenticated Responses: 200
View request and response details
ParametersNo path or query parameters
Responses200
PUT /api/v1/admin/profiles/{id}/block API key

Block a profile

Authenticated Responses: 200
View request and response details
ParametersNo path or query parameters
Responses200
PUT /api/v1/admin/profiles/{id}/unblock API key

Unblock a profile

Authenticated Responses: 200
View request and response details
ParametersNo path or query parameters
Responses200