AppEngine REST API

https://appengine.appmint.io

NestJS-based REST API v0.49+

Authentication Headers

orgId: YOUR_ORG_ID

Required for all API requests

x-api-key: YOUR_API_KEY

Optional API key for authentication

Authorization: Bearer YOUR_JWT_TOKEN

JWT token from signin/signup

Swagger Documentation

Authentication

User and customer authentication endpoints

/user, /profile
POST
/user/signin

Authenticate user with email and password

Request Body:

{
  "email": "[email protected]",
  "password": "password"
}

Response:

{
  "token": "jwt_token",
  "user": {
    "email": "..."
  }
}
POST
/signup

Create new user account

Request Body:

{
  "email": "[email protected]",
  "password": "password",
  "name": "John Doe"
}
POST
/user/refresh

Refresh JWT token

Request Body:

{
  "refresh_token": "refresh_token_here"
}
GET
/whoami

Get current authenticated user

POST
/customer/signin

Authenticate customer

Request Body:

{
  "email": "[email protected]",
  "password": "password"
}
POST
/customer/signup

Create customer account

GET
/password/forgot/:email

Initiate password reset

POST
/password/reset

Reset password with token

CRM - Forms & Leads

Contact forms, lead management

/crm
POST
/crm/contact-form/json/:app/:name

Submit contact form (JSON)

Request Body:

{
  "name": "John Doe",
  "email": "[email protected]",
  "message": "Hello"
}
POST
/crm/contact-form/post/:app/:name

Submit contact form (Form data)

GET
/crm/form/:name

Get CRM form by name

POST
/crm/form/submit/:name/:email?

Submit CRM form

POST
/crm/leads/detail

Get lead details with filtering

GET
/crm/leads/detail

Get all leads

CRM - Tickets

Support ticket management

/crm
GET
/crm/tickets/get/:number?

Get ticket(s) by number

POST
/crm/tickets/email/create/:email

Create ticket via email

GET
/crm/tickets/get-by-email/:email/:number?

Get tickets by customer email

CRM - Events

Event management

/crm
GET
/crm/events/get/:id?

Get event(s)

POST
/crm/events/create

Create new event

POST
/crm/events/update

Update event

DELETE
/crm/events/delete/:id

Delete event

CRM - Reservations

Appointment and reservation management

/crm
GET
/crm/reservations/definitions

Get reservation definitions

POST
/crm/reservations/slots

Get available appointment slots

GET
/crm/reservations/by-email/:email/:reservationNumber?

Get reservations by customer email

CRM - Ads

Cross-platform ad campaign management

/crm/ads
POST
/crm/ads/campaigns

Create ad campaign

GET
/crm/ads/campaigns

Get campaigns with filters

GET
/crm/ads/campaigns/:campaignId

Get campaign by ID

PUT
/crm/ads/campaigns/:campaignId

Update campaign

DELETE
/crm/ads/campaigns/:campaignId

Delete campaign

POST
/crm/ads/campaigns/launch/:campaignId

Launch campaign

POST
/crm/ads/campaigns/pause/:campaignId

Pause campaign

GET
/crm/ads/campaigns/metrics/:campaignId

Get campaign metrics

GET
/crm/ads/analytics/overview

Get analytics overview

CRM - Marketing

Marketing campaign management

/crm/marketing
GET
/crm/marketing/social-profiles/:platform?

Get social media profiles

POST
/crm/marketing/campaigns

Create marketing campaign

GET
/crm/marketing/campaigns

Get campaigns with filtering

GET
/crm/marketing/campaigns/:id

Get campaign by ID

PUT
/crm/marketing/campaigns/:id

Update campaign

DELETE
/crm/marketing/campaigns/:id

Delete campaign

GET
/crm/marketing/campaigns/:id/analytics

Get campaign analytics

GET
/crm/marketing/platforms

Get available platforms

GET
/crm/marketing/dashboard

Get campaign dashboard

CRM - Audience

Audience segment and targeting management

/crm/marketing/audiences
POST
/crm/marketing/audiences/segments

Create audience segment

GET
/crm/marketing/audiences/segments

Get audience segments

GET
/crm/marketing/audiences/segments/:id

Get segment by ID

PUT
/crm/marketing/audiences/segments/:id

Update segment

DELETE
/crm/marketing/audiences/segments/:id

Delete segment

POST
/crm/marketing/audiences/custom

Create custom audience

GET
/crm/marketing/audiences/segments/:id/insights

Get audience insights

POST
/crm/marketing/audiences/estimate-reach

Estimate audience reach

CRM - Lead Routing

Automated lead routing rules

/crm/lead-routing
POST
/crm/lead-routing/rules

Create routing rule

GET
/crm/lead-routing/rules

Get routing rules

PUT
/crm/lead-routing/rules/:id

Update routing rule

DELETE
/crm/lead-routing/rules/:id

Delete routing rule

POST
/crm/lead-routing/route-unassigned

Route all unassigned leads

GET
/crm/lead-routing/stats

Get routing statistics

CRM - Promotions

Marketing and promotion management

/crm
POST
/crm/promotion/subscribe/:promotion

Subscribe to promotion

Request Body:

{
  "email": "[email protected]"
}
POST
/crm/promotion/unsubscribe/:promotion

Unsubscribe from promotion

Request Body:

{
  "email": "[email protected]"
}

CRM - Messaging

Inbox and messaging system

/crm
GET
/crm/inbox/messages

Get inbox messages

GET
/crm/inbox/conversations

Get all conversations

GET
/crm/inbox/conversation/messages/:parties

Get messages for specific conversation

POST
/crm/inbox/update

Send/update message

DELETE
/crm/inbox/delete/:id

Delete message

POST
/crm/send-template

Send template message

CRM - Alerts

SMS and notification alerts

/crm/alert
GET
/crm/alert/sms/:id?

Get SMS alert

POST
/crm/alert/sms

Send SMS alert

CRM - Activity

Activity tracking and comments

/crm/activity
POST
/crm/activity/manage

Manage activity

GET
/crm/activity/by-customer/:datatype?/:ownerId?

Get activity by customer

GET
/crm/activity/by-resource/:datatype/:ownerId

Get activity by resource

POST
/crm/activity/comment/create

Create comment

GET
/crm/activity/comment/get/:datatype/:ownerId

Get comments

DELETE
/crm/activity/comment/delete/:id

Delete comment

Repository - Collections

CRUD operations for collections

/repository
GET
/repository/collections

List all collections

GET
/repository/collections/:name/detail

Get items from collection

POST
/repository/collections/:name/create

Create item in collection

POST
/repository/collections/:name/update

Update item in collection

DELETE
/repository/collections/:name/delete/:id

Delete item from collection

Repository - Organization

Organization management

/repository
GET
/repository/org/:orgid

Get organization details

GET
/repository/org

Query organizations

POST
/repository/org/create

Create organization

POST
/repository/org/update/:orgid

Update organization

Site Management

Site configuration and management

/site
GET
/site/get-site/:configSiteName/:domainName?

Get site configuration

GET
/site/get-site-by-hostname/:hostname

Get site by hostname

GET
/site/get-org/:domainName

Get organization by domain name

Storefront

E-commerce and product management

/storefront
GET
/storefront/brands/:brand?

Get brand(s)

GET
/storefront/collections/:collection?

Get product collections

AI

AI-powered features

/ai
GET
/ai/mcp/tools

Get available MCP tools

POST
/ai/mcp/execute

Execute MCP tool

POST
/ai/chat

Chat with AI

Request Body:

{
  "task": "Your message",
  "conversationHistory": []
}
POST
/ai/agent/chat

Chat with AI agent

POST
/ai/agent/stream

Stream chat with AI

GET
/ai/stream/:streamId

Get AI stream events (SSE)

POST
/ai/generate/image

Generate image with AI

Request Body:

{
  "prompt": "A beautiful landscape",
  "n": 1
}
POST
/ai/generate/video

Generate video with AI

POST
/ai/generate/data-viz

Generate data visualization

Analytics

Analytics and reporting

/analytics
GET
/analytics

Get general analytics

GET
/analytics/website

Get website analytics

GET
/analytics/blog

Get blog analytics

GET
/analytics/workflow

Get workflow analytics

GET
/analytics/storefront

Get storefront analytics

GET
/analytics/tickets

Get ticket analytics

GET
/analytics/leads

Get leads analytics

GET
/analytics/automation

Get automation analytics

GET
/analytics/social

Get social media analytics

GET
/analytics/users

Get user account analytics

GET
/analytics/email

Get email analytics

POST
/analytics/export

Export analytics data

Monitoring

System monitoring and health checks

/monitoring
GET
/monitoring/overview

Get system overview

GET
/monitoring/health

Get health check status

GET
/monitoring/system-metrics

Get system metrics

GET
/monitoring/queues

Get queue statistics

GET
/monitoring/queues/:queueName

Get specific queue details

GET
/monitoring/alerts

Get recent alerts

GET
/monitoring/usage

Get usage metrics

Integrations

Third-party integrations

/upstream
GET
/upstream/integration-types/:type?

Get integration types

GET
/upstream/get-config/:type?/:configId?

Get integration config

GET
/upstream/active/:type?

List active integrations

POST
/upstream/call/:integration/:operation

Call integration operation

GET
/upstream/call/:integration/:operation

Call integration operation (GET)

POST
/upstream/save-integration

Save integration config

POST
/upstream/shutdown/:id

Shutdown integration

Sync

Platform synchronization

/sync
GET
/sync

Get sync information

GET
/sync/info

Get org sync info

POST
/sync/queue

Queue sync job

POST
/sync/trigger

Trigger sync job

Request Body:

{
  "platform": "facebook",
  "syncType": "posts"
}
POST
/sync/trigger/:platform/:syncType

Trigger sync by URL params

GET
/sync/platforms

Get available platforms

GET
/sync/status

Get sync job status

POST
/sync/social-activities

Sync social activities

Tools

Utility tools and domain management

/tools
POST
/tools/web-visit

Track web visit

POST
/tools/web-activity

Track web activity

GET
/tools/domain/search/:domainName/:tld?

Search domain availability

POST
/tools/domain/search/advanced

Advanced domain search

POST
/tools/domain/buy

Buy domain

GET
/tools/domain/list/:domainName?/:orderId?

List domains

GET
/tools/domain/dns/:domainName/:type?

Get DNS records

POST
/tools/domain/dns/add

Add DNS record

POST
/tools/presentation/to-pdf

Convert page to PDF

POST
/tools/presentation/to-pptx

Convert page to PPTX

Chat

Live chat and messaging

/chat
GET
/chat/config/:chatId

Get chat configuration

GET
/chat/sessions

Get active sessions

POST
/chat/upload/:chatId/:userId

Upload files

POST
/chat/live/:chatId/:userId

Send live chat message

GET
/chat/messages/:email/:createdAfter?

Get user messages

GET
/chat/history/:chatId

Get chat history

POST
/chat/save/:chatId

Save message

PUT
/chat/update/:chatId

Update message

Payments (PayOxygen)

Payment processing and onboarding

/payoxygen
POST
/payoxygen/onboarding/start

Start org onboarding

POST
/payoxygen/onboarding/complete

Complete onboarding

GET
/payoxygen/onboarding/status

Get onboarding status

POST
/payoxygen/payment_intents

Create payment intent

Request Body:

{
  "amount": 1000,
  "currency": "USD"
}
POST
/payoxygen/payment_intents/:intentId/confirm

Confirm payment intent

GET
/payoxygen/payment_intents/:intentId

Get payment intent

App

Basic app endpoints

/
GET
/profile

Get user profile

GET
/version

Get API version

GET
/health

Health check

GET
/readiness

Readiness check

Quick Example

# Authenticate
curl -X POST https://appengine.appmint.io/user/signin \
  -H "orgId: YOUR_ORG_ID" \
  -H "Content-Type: application/json" \
  -d '{"email": "[email protected]", "password": "password"}'

# Use the API
curl https://appengine.appmint.io/repository/collections \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "orgId: YOUR_ORG_ID"
Complete Swagger DocsCollections Integration GuideAuth Integration Guide