Connected apps

Most providers follow one five-endpoint shape — list, create, bulk delete, read, update. See the Integrations guide.

Base URL https://api.leadx.in/api/key/protected. Every request needs an apikey header — see Authentication.

145 endpoints.

GET /apps

Get app details.

Auth apikey

:::note Used by the web app components/ContentMessaging.jsx, components/EmailProvider.jsx, components/ScheduleDelivery.jsx and 26 more :::

Response — data is one App object.

Errors AppNotFound_400

PUT /apps

Update app details.

Auth apikey · Success 200

:::note Used by the web app components/ContentMessaging.jsx, components/EmailProvider.jsx, components/ScheduleDelivery.jsx and 26 more :::

Request body

Field	Default
defaultSMTPServer	—
defaultS3Bucket	—
uniqueKey	—
companyType	—
defaultCompanyType	—
defaultOcr	—
defaultGemini	—
defaultClaude	—
defaultOffline	—
defaultZoom	—
defaultGoogleCalendar	—

Response — data is one App object.

GET /apps/brevo

Get all Brevo.

Auth apikey

:::note Used by the web app pages/AddBrevo.jsx, pages/Brevo.jsx :::

Query parameters — the standard list contract: p, n, sortBy, sortOrder, searchBy, searchValue, filters, advancedFilters, ids, nids. See Pagination and Filtering.

Response — data is an array of Brevo objects, alongside the pagination fields described in Response format.

POST /apps/brevo

Create Brevo.

Auth apikey · Success 201

:::note Used by the web app pages/AddBrevo.jsx, pages/Brevo.jsx :::

Request body

Field	Default
name	—
apiKey	—
fromEmail	—
fromName	—

Response — data is one Brevo object.

DELETE /apps/brevo

Delete Brevo.

Auth apikey · Success 200

:::note Used by the web app pages/AddBrevo.jsx, pages/Brevo.jsx :::

Request body — the standard bulk selection: ids, nids, selectAll. Query-string filters apply when selectAll is set.

Response — data is one App object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

Errors NoBrevoSelected_400

GET /apps/brevo/:id

Get Brevo.

Auth apikey

:::note Used by the web app pages/AddBrevo.jsx :::

Path parameters

Name
id	Required

Response — data is one Brevo object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

Errors BrevoNotFound_404

PUT /apps/brevo/:id

Update Brevo.

Auth apikey · Success 200

:::note Used by the web app pages/AddBrevo.jsx :::

Path parameters

Name
id	Required

Response — data is one Brevo object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

Errors BrevoNotFound_404

GET /apps/claude

Get Claude configurations.

Auth apikey

:::note Used by the web app pages/AddClaude.jsx, pages/Claude.jsx :::

Query parameters — the standard list contract: p, n, sortBy, sortOrder, searchBy, searchValue, filters, advancedFilters, ids, nids. See Pagination and Filtering.

Response — data is an array of Claude objects, alongside the pagination fields described in Response format.

POST /apps/claude

Create Claude configuration.

Auth apikey

:::note Used by the web app pages/AddClaude.jsx, pages/Claude.jsx :::

Request body

Field	Default
name	—
apiKey	—
selectedModel	—
modelSettings	—
isActive	—

Required: name, apiKey, selectedModel.

Response — data is one Claude object.

Errors ClaudeNotAvailableInPlan_400 · InvalidClaudeConfiguration_400

DELETE /apps/claude

Delete Claude configuration.

Auth apikey · Success 200

:::note Used by the web app pages/AddClaude.jsx, pages/Claude.jsx :::

Request body — the standard bulk selection: ids, nids, selectAll. Query-string filters apply when selectAll is set.

Response — data is null; the outcome is the status code and message.

GET /apps/claude/:id

Get Claude configuration.

Auth apikey

:::note Used by the web app pages/AddClaude.jsx :::

Path parameters

Name
id	Required

Response — data is one Claude object.

Errors ClaudeConfigurationNotFound_400 · ClaudeNotAvailableInPlan_400

PUT /apps/claude/:id

Update Claude configuration.

Auth apikey

:::note Used by the web app pages/AddClaude.jsx :::

Path parameters

Name
id	Required

Request body

Field	Default
name	—
apiKey	—
selectedModel	—
modelSettings	—
isActive	—

Response — data is one Claude object.

Errors ClaudeConfigurationNotFound_400 · ClaudeNotAvailableInPlan_400

GET /apps/claude/models

Get available Claude models.

Auth apikey

Errors ClaudeNotAvailableInPlan_400

GET /apps/elasticemail

Get all ElasticEmail.

Auth apikey

:::note Used by the web app pages/AddElasticemail.jsx, pages/Elasticemail.jsx :::

Query parameters — the standard list contract: p, n, sortBy, sortOrder, searchBy, searchValue, filters, advancedFilters, ids, nids. See Pagination and Filtering.

Response — data is an array of Elasticemail objects, alongside the pagination fields described in Response format.

POST /apps/elasticemail

Create ElasticEmail.

Auth apikey · Success 201

:::note Used by the web app pages/AddElasticemail.jsx, pages/Elasticemail.jsx :::

Request body

Field	Default
name	—
apiKey	—
fromEmail	—
fromName	—

Response — data is one Elasticemail object.

DELETE /apps/elasticemail

Delete ElasticEmail.

Auth apikey · Success 200

:::note Used by the web app pages/AddElasticemail.jsx, pages/Elasticemail.jsx :::

Request body — the standard bulk selection: ids, nids, selectAll. Query-string filters apply when selectAll is set.

Response — data is one App object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

Errors NoElasticemailSelected_400

GET /apps/elasticemail/:id

Get ElasticEmail.

Auth apikey

:::note Used by the web app pages/AddElasticemail.jsx :::

Path parameters

Name
id	Required

Response — data is one Elasticemail object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

Errors ElasticemailNotFound_404

PUT /apps/elasticemail/:id

Update ElasticEmail.

Auth apikey · Success 200

:::note Used by the web app pages/AddElasticemail.jsx :::

Path parameters

Name
id	Required

Response — data is one Elasticemail object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

Errors ElasticemailNotFound_404

POST /apps/facebook/apps

Create Facebook app.

Auth apikey

:::note Used by the web app pages/AddFacebook.jsx :::

Request body

Field	Default
appID	—
secret	—
type	—

Response — data is one FacebookApp object.

Errors FacebookAppIDRequired_400 · FacebookSecretRequired_400

GET /apps/facebook/apps/:id

Get Facebook app by ID.

Auth apikey

:::note Used by the web app pages/AddFacebook.jsx :::

Path parameters

Name
id	Required

Response — data is one App object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

PUT /apps/facebook/apps/:id

Update Facebook app.

Auth apikey

:::note Used by the web app pages/AddFacebook.jsx :::

Path parameters

Name
id	Required

Request body

Field	Default
appID	—
secret	—
type	—

Response — data is one FacebookApp object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

GET /apps/facebook/form/details

Get form details.

Auth apikey

Request body

Field	Default
formId	—
accessToken	—

Errors FormIdOrTokenRequired_400

GET /apps/facebook/form/leads

Get form leads.

Auth apikey

Request body

Field	Default
formId	—
accessToken	—
limit	—
after	—

Errors FormIdOrTokenRequired_400

PUT /apps/facebook/forms/:id

Update form.

Auth apikey

:::note Used by the web app pages/AddFacebook.jsx :::

Path parameters

Name
id	Required

Request body

Field	Default
isActive	—

GET /apps/facebook/lead

Get specific lead.

Auth apikey

Request body

Field	Default
leadId	—
accessToken	—

Errors LeadIdOrTokenRequired_400

PUT /apps/facebook/lead/status

Update lead status.

Auth apikey · Success 200

Request body

Field	Default
leadId	—
accessToken	—
status	—
notes	—

Errors LeadIdTokenStatusRequired_400

GET /apps/facebook/page/forms

Get page lead forms.

Auth apikey

Request body

Field	Default
pageId	—
pageAccessToken	—

Errors PageIdOrTokenRequired_400

GET /apps/facebook/pages

Get user pages.

Auth apikey

:::note Used by the web app pages/AddFacebook.jsx :::

Response — data is one Page object. forms is populated, so it arrives as nested objects rather than ids.

GET /apps/facebook/sync/form-leads/:id

Sync form leads.

Auth apikey · Success 200

:::note Used by the web app pages/AddFacebook.jsx :::

Path parameters

Name
id	Required

Response — data is one App object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

Errors FacebookTokenRequired_400 · FormIdRequired_400

GET /apps/facebook/sync/job-status/:jobId

Get sync job status.

Auth apikey

Path parameters

Name
jobId	Required

Errors JobIdRequired_400

GET /apps/facebook/sync/manual-job

Create manual sync job.

Auth apikey · Success 201

Request body

Field	Default
formId	—
priority	—

GET /apps/facebook/sync/page-forms-leads/:id

Sync page forms leads.

Auth apikey · Success 200

:::note Used by the web app pages/AddFacebook.jsx :::

Path parameters

Name
id	Required

Response — data is one App object.

Errors FacebookTokenRequired_400 · PageIdRequired_400

GET /apps/facebook/sync/page-forms/:id

Sync forms by page.

Auth apikey

:::note Used by the web app pages/AddFacebook.jsx :::

Path parameters

Name
id	Required

Response — data is one App object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

GET /apps/facebook/sync/pages-forms

Sync forms by pages.

Auth apikey

:::note Used by the web app pages/AddFacebook.jsx :::

Response — data is one App object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

GET /apps/facebook/sync/pages-forms-leads

Sync pages forms leads.

Auth apikey · Success 200

:::note Used by the web app pages/AddFacebook.jsx :::

Response — data is one App object.

Errors FacebookTokenRequired_400

GET /apps/facebook/sync/process-job

Process sync job.

Auth apikey · Success 200

Request body

Field	Default
jobId	—

Errors JobIdRequired_400

GET /apps/facebook/sync/schedule

Schedule periodic sync.

Auth apikey · Success 201

Request body

Field	Default
intervalHours	—

GET /apps/facebook/sync/webhook-failures

Replay Facebook leads whose webhook delivery failed.

Auth apikey · Success 200

GET /apps/facebook/sync/webhook-fallback-job

Create webhook fallback job.

Auth apikey · Success 201

Request body

Field	Default
formId	—
leadId	—

Errors FormIdRequired_400

POST /apps/facebook/validate-token

Validate Facebook token.

Auth apikey

Request body

Field	Default
accessToken	—

Errors FacebookTokenRequired_400

GET /apps/gemini

Get Gemini configurations.

Auth apikey

:::note Used by the web app pages/AddGemini.jsx, pages/Gemini.jsx :::

Query parameters — the standard list contract: p, n, sortBy, sortOrder, searchBy, searchValue, filters, advancedFilters, ids, nids. See Pagination and Filtering.

Response — data is an array of Gemini objects, alongside the pagination fields described in Response format.

POST /apps/gemini

Create Gemini configuration.

Auth apikey

:::note Used by the web app pages/AddGemini.jsx, pages/Gemini.jsx :::

Request body

Field	Default
name	—
apiKey	—
selectedModel	—
modelSettings	—
isActive	—

Required: name, apiKey, selectedModel.

Response — data is one Gemini object.

Errors GeminiNotAvailableInPlan_400 · InvalidGeminiConfiguration_400

DELETE /apps/gemini

Delete Gemini configuration.

Auth apikey · Success 200

:::note Used by the web app pages/AddGemini.jsx, pages/Gemini.jsx :::

Request body — the standard bulk selection: ids, nids, selectAll. Query-string filters apply when selectAll is set.

Response — data is null; the outcome is the status code and message.

GET /apps/gemini/:id

Get Gemini configuration.

Auth apikey

:::note Used by the web app pages/AddGemini.jsx :::

Path parameters

Name
id	Required

Response — data is one Gemini object.

Errors GeminiConfigurationNotFound_400 · GeminiNotAvailableInPlan_400

PUT /apps/gemini/:id

Update Gemini configuration.

Auth apikey

:::note Used by the web app pages/AddGemini.jsx :::

Path parameters

Name
id	Required

Request body

Field	Default
name	—
apiKey	—
selectedModel	—
modelSettings	—
isActive	—

Response — data is one Gemini object.

Errors GeminiConfigurationNotFound_400 · GeminiNotAvailableInPlan_400

GET /apps/gemini/models

Get available models.

Auth apikey

Errors GeminiNotAvailableInPlan_400

GET /apps/gmail

Get all Gmail.

Auth apikey

Query parameters — the standard list contract: p, n, sortBy, sortOrder, searchBy, searchValue, filters, advancedFilters, ids, nids. See Pagination and Filtering.

Response — data is an array of Gmail objects, alongside the pagination fields described in Response format.

POST /apps/gmail

Handle Gmail callback.

Auth apikey · Success 201

Request body

Field	Default
code	—

Response — data is one Gmail object.

Errors GmailCodeRequired_400

DELETE /apps/gmail

Delete Gmail.

Auth apikey · Success 200

Request body — the standard bulk selection: ids, nids, selectAll. Query-string filters apply when selectAll is set.

Response — data is null; the outcome is the status code and message.

GET /apps/gmail/:id

Get Gmail.

Auth apikey

Path parameters

Name
id	Required

Response — data is one Gmail object.

Errors GmailNotFound_404

PUT /apps/gmail/:id

Update Gmail.

Auth apikey · Success 200

Path parameters

Name
id	Required

Response — data is one Gmail object.

Errors GmailNotFound_404

GET /apps/gmail/redirect

Get redirect URI.

Auth apikey

GET /apps/gmail/refresh

Refresh Gmail.

Auth apikey

Request body

Field	Default
code	—

Response — data is one Gmail object.

GET /apps/google-calendar

Get Google calendar accounts.

Auth apikey

:::note Used by the web app components/MemberGoogleCalendarAssignment.jsx, pages/GoogleCalendar.jsx :::

Query parameters — the standard list contract: p, n, sortBy, sortOrder, searchBy, searchValue, filters, advancedFilters, ids, nids. See Pagination and Filtering.

Response — data is an array of GoogleCalendarAccount objects, alongside the pagination fields described in Response format.

POST /apps/google-calendar

Create Google calendar account.

Auth apikey · Success 200

:::note Used by the web app components/MemberGoogleCalendarAssignment.jsx, pages/GoogleCalendar.jsx :::

Request body

Field	Default
name	—
authType	manual
clientId	—
clientSecret	—
refreshToken	—
calendarId	—

Required: name, clientId, clientSecret, refreshToken.

DELETE /apps/google-calendar

Delete Google calendar accounts.

Auth apikey · Success 200

:::note Used by the web app components/MemberGoogleCalendarAssignment.jsx, pages/GoogleCalendar.jsx :::

Request body — the standard bulk selection: ids, nids, selectAll. Query-string filters apply when selectAll is set.

Response — data is null; the outcome is the status code and message.

GET /apps/google-calendar/:id

Get Google calendar account.

Auth apikey

Path parameters

Name
id	Required

PUT /apps/google-calendar/:id

Update Google calendar account.

Auth apikey · Success 200

Path parameters

Name
id	Required

POST /apps/google-calendar/redirect

Get Google calendar redirect URI.

Auth apikey

GET /apps/instagram

Get all Instagram apps.

Auth apikey

:::note Used by the web app pages/AddInstagram.jsx, pages/Instagram.jsx :::

Query parameters — the standard list contract: p, n, sortBy, sortOrder, searchBy, searchValue, filters, advancedFilters, ids, nids. See Pagination and Filtering.

Response — data is an array of InstagramApp objects, alongside the pagination fields described in Response format.

POST /apps/instagram

Create Instagram app.

Auth apikey · Success 201

:::note Used by the web app pages/AddInstagram.jsx, pages/Instagram.jsx :::

Request body

Field	Default
name	—
appId	—
appSecret	—

Required: name, appId, appSecret.

GET /apps/instagram/:id

Get Instagram app.

Auth apikey

:::note Used by the web app pages/AddInstagram.jsx :::

Path parameters

Name
id	Required

Errors InstagramAppNotFound_404

PUT /apps/instagram/:id

Update Instagram app.

Auth apikey · Success 200

:::note Used by the web app pages/AddInstagram.jsx :::

Path parameters

Name
id	Required

Request body

Field	Default
name	—
appId	—
appSecret	—
accessToken	—
pageId	—

Errors InstagramAppNotFound_404

GET /apps/instagram/:id/accounts

Get app Instagram accounts.

Auth apikey

:::note Used by the web app pages/AddInstagram.jsx :::

Path parameters

Name
id	Required

Errors InstagramAppNotFound_404

POST /apps/instagram/:id/accounts

Create Instagram account.

Auth apikey · Success 201

:::note Used by the web app pages/AddInstagram.jsx :::

Path parameters

Name
id	Required

Request body

Field	Default
instagramUserId	—
instagramUsername	—
name	—
pageId	—
pageName	—
accountType	—

Required: instagramUserId.

GET /apps/instagram/:id/accounts/:accountId

Get Instagram account.

Auth apikey

:::note Used by the web app pages/AddInstagram.jsx :::

Path parameters

Name
id	Required
accountId	Required

Errors InstagramAccountNotFound_404 · InstagramAppNotFound_404

PUT /apps/instagram/:id/accounts/:accountId

Update Instagram account.

Auth apikey · Success 200

:::note Used by the web app pages/AddInstagram.jsx :::

Path parameters

Name
id	Required
accountId	Required

Errors InstagramAppNotFound_404

DELETE /apps/instagram/:id/accounts/:accountId

Delete Instagram account.

Auth apikey · Success 200

:::note Used by the web app pages/AddInstagram.jsx :::

Path parameters

Name
id	Required
accountId	Required

Response — data is null; the outcome is the status code and message.

Errors InstagramAppNotFound_404

POST /apps/instagram/:id/accounts/:accountId/comment/like

Like Instagram comment by account.

Auth apikey · Success 200

Path parameters

Name
id	Required
accountId	Required

Request body

Field	Default
commentId	—

Required: commentId.

POST /apps/instagram/:id/accounts/:accountId/comment/reply

Reply Instagram comment by account.

Auth apikey · Success 200

Path parameters

Name
id	Required
accountId	Required

Request body

Field	Default
commentId	—
text	—

Required: commentId, text.

POST /apps/instagram/:id/accounts/:accountId/reply

Reply Instagram DM by account.

Auth apikey · Success 200

Path parameters

Name
id	Required
accountId	Required

Request body

Field	Default
messageId	—
text	—

Required: messageId, text.

POST /apps/instagram/:id/accounts/:accountId/send

Send Instagram DM by account.

Auth apikey · Success 200

Path parameters

Name
id	Required
accountId	Required

Request body

Field	Default
recipientId	—
senderId	—
message	—

Required: recipientId, senderId, message.

Response — data is one UnifiedMessage object.

POST /apps/instagram/:id/oauth/refresh

Refresh Instagram token.

Auth apikey · Success 200

Path parameters

Name
id	Required

Errors InstagramAppNotFound_404 · InvalidRequest_400

GET /apps/instagram/:id/oauth/status

Get Instagram OAuth status.

Auth apikey

Path parameters

Name
id	Required

Errors InstagramAppNotFound_404

POST /apps/instagram/:id/send-me

Auth apikey

Path parameters

Name
id	Required

POST /apps/instagram/:id/webhook/subscribe

Subscribe Instagram webhook.

Auth apikey · Success 200

Path parameters

Name
id	Required

Errors InstagramAppNotFound_404 · InvalidRequest_400 · WebhookSubscriptionFailed_500

POST /apps/instagram/oauth/callback

Handle Instagram OAuth callback.

Auth apikey

:::note Used by the web app pages/AddInstagram.jsx :::

Query parameters

Field	Default
code	—
state	—

Errors Unauthorized_401

POST /apps/instagram/oauth/init

Init Instagram OAuth.

Auth apikey · Success 200

:::note Used by the web app pages/AddInstagram.jsx :::

Request body

Field	Default
scopes	—

Response — data is one App object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

GET /apps/mailchimp

Get all Mailchimp.

Auth apikey

:::note Used by the web app pages/AddMailchimp.jsx, pages/Mailchimp.jsx :::

Query parameters — the standard list contract: p, n, sortBy, sortOrder, searchBy, searchValue, filters, advancedFilters, ids, nids. See Pagination and Filtering.

Response — data is an array of Mailchimp objects, alongside the pagination fields described in Response format.

POST /apps/mailchimp

Create Mailchimp.

Auth apikey · Success 201

:::note Used by the web app pages/AddMailchimp.jsx, pages/Mailchimp.jsx :::

Request body

Field	Default
name	—
apiKey	—
fromEmail	—
fromName	—

Response — data is one Mailchimp object.

DELETE /apps/mailchimp

Delete Mailchimp.

Auth apikey · Success 200

:::note Used by the web app pages/AddMailchimp.jsx, pages/Mailchimp.jsx :::

Request body — the standard bulk selection: ids, nids, selectAll. Query-string filters apply when selectAll is set.

Response — data is one App object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

Errors NoMailchimpSelected_400

GET /apps/mailchimp/:id

Get Mailchimp.

Auth apikey

:::note Used by the web app pages/AddMailchimp.jsx :::

Path parameters

Name
id	Required

Response — data is one Mailchimp object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

Errors MailchimpNotFound_404

PUT /apps/mailchimp/:id

Update Mailchimp.

Auth apikey · Success 200

:::note Used by the web app pages/AddMailchimp.jsx :::

Path parameters

Name
id	Required

Response — data is one Mailchimp object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

Errors MailchimpNotFound_404

POST /apps/oAuthWhatsApp/:id/complete-onboarding

Complete OAuth WhatsApp onboarding.

Auth apikey

Path parameters

Name
id	Required

Request body

Field	Default
code	—
sessionInfo	—
name	—
redirectUri	—
pin	—

Required: code.

GET /apps/ocr

Get all ocr.

Auth apikey

:::note Used by the web app pages/AddOcr.jsx, pages/OCR.jsx :::

Query parameters — the standard list contract: p, n, sortBy, sortOrder, searchBy, searchValue, filters, advancedFilters, ids, nids. See Pagination and Filtering.

Response — data is an array of Ocr objects, alongside the pagination fields described in Response format.

POST /apps/ocr

Create ocr.

Auth apikey · Success 200

:::note Used by the web app pages/AddOcr.jsx, pages/OCR.jsx :::

Request body

Field	Default
name	—
key	—

Response — data is one Ocr object.

Errors OcrNotFound_404

DELETE /apps/ocr

Delete ocr.

Auth apikey · Success 200

:::note Used by the web app pages/AddOcr.jsx, pages/OCR.jsx :::

Request body — the standard bulk selection: ids, nids, selectAll. Query-string filters apply when selectAll is set.

Response — data is one App object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

GET /apps/ocr/:id

Get ocr.

Auth apikey

:::note Used by the web app components/CustomFieldsBasedForm.jsx, pages/AddOcr.jsx, pages/ScanAndCreate.jsx :::

Path parameters

Name
id	Required

Response — data is one Ocr object.

Errors OcrNotFound_404

PUT /apps/ocr/:id

Update ocr.

Auth apikey · Success 200

:::note Used by the web app components/CustomFieldsBasedForm.jsx, pages/AddOcr.jsx, pages/ScanAndCreate.jsx :::

Path parameters

Name
id	Required

Response — data is one Ocr object.

Errors OcrNotFound_404

POST /apps/ocr/image

Do OCR and parse.

Auth apikey · Success 200

Request body

Field	Default
fileIDs	—

Response — data is one App object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

Errors OcrNotFound_404

GET /apps/offline-meeting

Get all offline venues.

Auth apikey

:::note Used by the web app components/ScheduleMeetingModal.jsx, pages/AddMeeting.jsx, pages/AddOfflineMeeting.jsx and 1 more :::

Query parameters — the standard list contract: p, n, sortBy, sortOrder, searchBy, searchValue, filters, advancedFilters, ids, nids. See Pagination and Filtering.

Response — data is an array of OfflineLocation objects, alongside the pagination fields described in Response format. createdBy is populated, so it arrives as nested objects rather than ids.

POST /apps/offline-meeting

Create offline venue.

Auth apikey · Success 200

:::note Used by the web app components/ScheduleMeetingModal.jsx, pages/AddMeeting.jsx, pages/AddOfflineMeeting.jsx and 1 more :::

Request body

Field	Default
name	—
address	—
mapLink	—
notes	—

Required: name.

Response — data is one OfflineLocation object.

DELETE /apps/offline-meeting

Delete offline venues.

Auth apikey · Success 200

:::note Used by the web app components/ScheduleMeetingModal.jsx, pages/AddMeeting.jsx, pages/AddOfflineMeeting.jsx and 1 more :::

Request body — the standard bulk selection: ids, nids, selectAll. Query-string filters apply when selectAll is set.

Response — data is null; the outcome is the status code and message.

GET /apps/offline-meeting/:id

Get offline venue.

Auth apikey

:::note Used by the web app pages/AddOfflineMeeting.jsx :::

Path parameters

Name
id	Required

Response — data is one OfflineLocation object.

PUT /apps/offline-meeting/:id

Update offline venue.

Auth apikey · Success 200

:::note Used by the web app pages/AddOfflineMeeting.jsx :::

Path parameters

Name
id	Required

Response — data is one OfflineLocation object.

DELETE /apps/offline-meeting/:id

Delete offline venue.

Auth apikey · Success 200

:::note Used by the web app pages/AddOfflineMeeting.jsx :::

Path parameters

Name
id	Required

Response — data is null; the outcome is the status code and message.

GET /apps/postmark

Get all Postmark.

Auth apikey

:::note Used by the web app pages/AddPostmark.jsx, pages/Postmark.jsx :::

Query parameters — the standard list contract: p, n, sortBy, sortOrder, searchBy, searchValue, filters, advancedFilters, ids, nids. See Pagination and Filtering.

Response — data is an array of Postmark objects, alongside the pagination fields described in Response format.

POST /apps/postmark

Create Postmark.

Auth apikey · Success 201

:::note Used by the web app pages/AddPostmark.jsx, pages/Postmark.jsx :::

Request body

Field	Default
name	—
serverToken	—
messageStream	—
fromEmail	—
fromName	—

Response — data is one Postmark object.

DELETE /apps/postmark

Delete Postmark.

Auth apikey · Success 200

:::note Used by the web app pages/AddPostmark.jsx, pages/Postmark.jsx :::

Request body — the standard bulk selection: ids, nids, selectAll. Query-string filters apply when selectAll is set.

Response — data is one App object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

Errors NoPostmarkSelected_400

GET /apps/postmark/:id

Get Postmark.

Auth apikey

:::note Used by the web app pages/AddPostmark.jsx :::

Path parameters

Name
id	Required

Response — data is one Postmark object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

Errors PostmarkNotFound_404

PUT /apps/postmark/:id

Update Postmark.

Auth apikey · Success 200

:::note Used by the web app pages/AddPostmark.jsx :::

Path parameters

Name
id	Required

Response — data is one Postmark object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

Errors PostmarkNotFound_404

GET /apps/s3bucket

Get all S3 bucket.

Auth apikey

:::note Used by the web app pages/AWSS3Bucket.jsx, pages/AddS3Bucket.jsx :::

Query parameters — the standard list contract: p, n, sortBy, sortOrder, searchBy, searchValue, filters, advancedFilters, ids, nids. See Pagination and Filtering.

Response — data is an array of Bucket objects, alongside the pagination fields described in Response format.

POST /apps/s3bucket

Create S3 bucket.

Auth apikey · Success 201

:::note Used by the web app pages/AWSS3Bucket.jsx, pages/AddS3Bucket.jsx :::

Request body

Field	Default
accesskey	—
secretkey	—
region	—
name	—
subpath	—

Response — data is one Bucket object.

PUT /apps/s3bucket

Bulk update S3 bucket.

Auth apikey · Success 200

:::note Used by the web app pages/AWSS3Bucket.jsx, pages/AddS3Bucket.jsx :::

Request body

Field	Default	Notes
updateType	—	replace (default), or append for array-valued custom fields.
formData	{}	System and custom fields together — see Custom fields.

Response — data is one App object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

DELETE /apps/s3bucket

Delete S3 bucket.

Auth apikey · Success 200

:::note Used by the web app pages/AWSS3Bucket.jsx, pages/AddS3Bucket.jsx :::

Request body — the standard bulk selection: ids, nids, selectAll. Query-string filters apply when selectAll is set.

Response — data is one App object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

GET /apps/s3bucket/:id

Get S3 bucket.

Auth apikey

:::note Used by the web app pages/AddS3Bucket.jsx :::

Path parameters

Name
id	Required

Response — data is one Bucket object.

Errors S3BucketNotFound_404

PUT /apps/s3bucket/:id

Update S3 bucket.

Auth apikey · Success 200

:::note Used by the web app pages/AddS3Bucket.jsx :::

Path parameters

Name
id	Required

Response — data is one Bucket object.

Errors S3BucketNotFound_404

GET /apps/sendgrid

Get all SendGrid.

Auth apikey

:::note Used by the web app pages/AddSendgrid.jsx, pages/Sendgrid.jsx :::

Query parameters — the standard list contract: p, n, sortBy, sortOrder, searchBy, searchValue, filters, advancedFilters, ids, nids. See Pagination and Filtering.

Response — data is an array of Sendgrid objects, alongside the pagination fields described in Response format.

POST /apps/sendgrid

Create SendGrid.

Auth apikey · Success 201

:::note Used by the web app pages/AddSendgrid.jsx, pages/Sendgrid.jsx :::

Request body

Field	Default
name	—
apiKey	—
fromEmail	—
fromName	—

Response — data is one Sendgrid object.

DELETE /apps/sendgrid

Delete SendGrid.

Auth apikey · Success 200

:::note Used by the web app pages/AddSendgrid.jsx, pages/Sendgrid.jsx :::

Request body — the standard bulk selection: ids, nids, selectAll. Query-string filters apply when selectAll is set.

Response — data is one App object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

Errors NoSendgridSelected_400

GET /apps/sendgrid/:id

Get SendGrid.

Auth apikey

:::note Used by the web app pages/AddSendgrid.jsx :::

Path parameters

Name
id	Required

Response — data is one Sendgrid object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

Errors SendgridNotFound_404

PUT /apps/sendgrid/:id

Update SendGrid.

Auth apikey · Success 200

:::note Used by the web app pages/AddSendgrid.jsx :::

Path parameters

Name
id	Required

Response — data is one Sendgrid object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

Errors SendgridNotFound_404

GET /apps/ses

Get all SES.

Auth apikey

:::note Used by the web app pages/AddSes.jsx, pages/Ses.jsx :::

Query parameters — the standard list contract: p, n, sortBy, sortOrder, searchBy, searchValue, filters, advancedFilters, ids, nids. See Pagination and Filtering.

Response — data is an array of Ses objects, alongside the pagination fields described in Response format.

POST /apps/ses

Create SES.

Auth apikey · Success 201

:::note Used by the web app pages/AddSes.jsx, pages/Ses.jsx :::

Request body

Field	Default
name	—
accessKeyId	—
secretAccessKey	—
region	—
fromEmail	—
fromName	—

Response — data is one Ses object.

DELETE /apps/ses

Delete SES.

Auth apikey · Success 200

:::note Used by the web app pages/AddSes.jsx, pages/Ses.jsx :::

Request body — the standard bulk selection: ids, nids, selectAll. Query-string filters apply when selectAll is set.

Response — data is one App object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

Errors NoSESSelected_400

GET /apps/ses/:id

Get SES.

Auth apikey

:::note Used by the web app pages/AddSes.jsx :::

Path parameters

Name
id	Required

Response — data is one Ses object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

Errors SESNotFound_404

PUT /apps/ses/:id

Update SES.

Auth apikey · Success 200

:::note Used by the web app pages/AddSes.jsx :::

Path parameters

Name
id	Required

Response — data is one Ses object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

Errors SESNotFound_404

GET /apps/smtp

Get all SMTP.

Auth apikey

:::note Used by the web app components/EmailMessageSend.jsx, pages/AIGeniePage.jsx, pages/AddSMTP.jsx and 2 more :::

Query parameters — the standard list contract: p, n, sortBy, sortOrder, searchBy, searchValue, filters, advancedFilters, ids, nids. See Pagination and Filtering.

Response — data is an array of Smtp objects, alongside the pagination fields described in Response format.

POST /apps/smtp

Create SMTP.

Auth apikey · Success 201

:::note Used by the web app components/EmailMessageSend.jsx, pages/AIGeniePage.jsx, pages/AddSMTP.jsx and 2 more :::

Request body

Field	Default
name	—
host	—
port	—
username	—
password	—
secure	—
fromEmail	—
fromName	—

Response — data is one Smtp object.

DELETE /apps/smtp

Delete SMTP.

Auth apikey · Success 200

:::note Used by the web app components/EmailMessageSend.jsx, pages/AIGeniePage.jsx, pages/AddSMTP.jsx and 2 more :::

Request body — the standard bulk selection: ids, nids, selectAll. Query-string filters apply when selectAll is set.

Response — data is one App object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

Errors NoSMTPSelected_400

GET /apps/smtp/:id

Get SMTP.

Auth apikey

:::note Used by the web app pages/AddSMTP.jsx :::

Path parameters

Name
id	Required

Response — data is one Smtp object.

Errors SMTPNotFound_404

PUT /apps/smtp/:id

Update SMTP.

Auth apikey · Success 200

:::note Used by the web app pages/AddSMTP.jsx :::

Path parameters

Name
id	Required

Response — data is one Smtp object.

Errors SMTPNotFound_404

GET /apps/sparkpost

Get all SparkPost.

Auth apikey

:::note Used by the web app pages/AddSparkpost.jsx, pages/Sparkpost.jsx :::

Query parameters — the standard list contract: p, n, sortBy, sortOrder, searchBy, searchValue, filters, advancedFilters, ids, nids. See Pagination and Filtering.

Response — data is an array of Sparkpost objects, alongside the pagination fields described in Response format.

POST /apps/sparkpost

Create SparkPost.

Auth apikey · Success 201

:::note Used by the web app pages/AddSparkpost.jsx, pages/Sparkpost.jsx :::

Request body

Field	Default
name	—
apiKey	—
endpoint	—
fromEmail	—
fromName	—

Response — data is one Sparkpost object.

DELETE /apps/sparkpost

Delete SparkPost.

Auth apikey · Success 200

:::note Used by the web app pages/AddSparkpost.jsx, pages/Sparkpost.jsx :::

Request body — the standard bulk selection: ids, nids, selectAll. Query-string filters apply when selectAll is set.

Response — data is one App object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

Errors NoSparkpostSelected_400

GET /apps/sparkpost/:id

Get SparkPost.

Auth apikey

:::note Used by the web app pages/AddSparkpost.jsx :::

Path parameters

Name
id	Required

Response — data is one Sparkpost object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

Errors SparkpostNotFound_404

PUT /apps/sparkpost/:id

Update SparkPost.

Auth apikey · Success 200

:::note Used by the web app pages/AddSparkpost.jsx :::

Path parameters

Name
id	Required

Response — data is one Sparkpost object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

Errors SparkpostNotFound_404

GET /apps/telegram

Get all Telegram apps.

Auth apikey

:::note Used by the web app pages/AddTelegram.jsx, pages/Telegram.jsx :::

Query parameters — the standard list contract: p, n, sortBy, sortOrder, searchBy, searchValue, filters, advancedFilters, ids, nids. See Pagination and Filtering.

Response — data is an array of TelegramApp objects, alongside the pagination fields described in Response format.

POST /apps/telegram

Create Telegram app.

Auth apikey · Success 201

:::note Used by the web app pages/AddTelegram.jsx, pages/Telegram.jsx :::

Request body

Field	Default
name	—
token	—

Required: name, token.

DELETE /apps/telegram

Delete Telegram apps.

Auth apikey · Success 200

:::note Used by the web app pages/AddTelegram.jsx, pages/Telegram.jsx :::

Request body — the standard bulk selection: ids, nids, selectAll. Query-string filters apply when selectAll is set.

Response — data is null; the outcome is the status code and message.

GET /apps/telegram/:id

Get Telegram app.

Auth apikey

:::note Used by the web app pages/AddTelegram.jsx :::

Path parameters

Name
id	Required

Errors TelegramAppNotFound_404

PUT /apps/telegram/:id

Update Telegram app.

Auth apikey · Success 200

:::note Used by the web app pages/AddTelegram.jsx :::

Path parameters

Name
id	Required

Request body

Field	Default
name	—
token	—

Errors TelegramAppNotFound_404

GET /apps/whatsapp

Get all WhatsApp.

Auth apikey

:::note Used by the web app components/GenerateWhatsappTemplateModal.jsx, components/WhatsappMessageSend.jsx, pages/AIGeniePage.jsx and 6 more :::

Query parameters — the standard list contract: p, n, sortBy, sortOrder, searchBy, searchValue, filters, advancedFilters, ids, nids. See Pagination and Filtering.

Response — data is an array of MetaApp objects, alongside the pagination fields described in Response format.

POST /apps/whatsapp

Create WhatsApp.

Auth apikey · Success 201

:::note Used by the web app components/GenerateWhatsappTemplateModal.jsx, components/WhatsappMessageSend.jsx, pages/AIGeniePage.jsx and 6 more :::

Request body

Field	Default
countryCode	—
number	—
appID	—
numberID	—
businessID	—
PAT	—
pin	—
appSecret	—
name	—

Response — data is one MetaApp object.

GET /apps/whatsapp/:id

Get WhatsApp.

Auth apikey

:::note Used by the web app pages/AddWhatsapp.jsx, pages/Whatsapp.jsx :::

Path parameters

Name
id	Required

Errors WhatsappNotFound_404

PUT /apps/whatsapp/:id

Update WhatsApp.

Auth apikey · Success 200

:::note Used by the web app pages/AddWhatsapp.jsx, pages/Whatsapp.jsx :::

Path parameters

Name
id	Required

Errors WhatsappNotFound_404

POST /apps/whatsapp/oauth/callback

Complete WhatsApp OAuth.

Auth apikey · Success 200

:::note Used by the web app pages/AddWhatsapp.jsx :::

Request body

Field	Default
code	—
state	—
sessionInfo	{}
pin	—
name	—
redirectUri	""

Required: code, state.

Response — data is one App object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

Errors InvalidRequest_400

POST /apps/whatsapp/oauth/init

Init WhatsApp OAuth.

Auth apikey · Success 200

:::note Used by the web app pages/AddWhatsapp.jsx :::

Request body

Field	Default
redirectPath	/apps/whatsapp

Response — data is one App object. (Resource deduced from the collections this handler reads, not read off an explicit return.)

Errors InvalidRequest_400

GET /apps/whatsapp/verify/:id

Register the WhatsApp number and subscribe its webhook.

Auth apikey · Success 201

Path parameters

Name
id	Required

Response — data is one MetaApp object.

GET /apps/zoom

Get Zoom accounts.

Auth apikey

:::note Used by the web app components/MemberZoomAssignment.jsx, pages/AddMeeting.jsx, pages/AddZoom.jsx and 1 more :::

Query parameters — the standard list contract: p, n, sortBy, sortOrder, searchBy, searchValue, filters, advancedFilters, ids, nids. See Pagination and Filtering.

Response — data is an array of ZoomAccount objects, alongside the pagination fields described in Response format.

POST /apps/zoom

Create Zoom account.

Auth apikey · Success 200

:::note Used by the web app components/MemberZoomAssignment.jsx, pages/AddMeeting.jsx, pages/AddZoom.jsx and 1 more :::

Request body

Field	Default
name	—
authType	manual
accountId	—
clientId	—
clientSecret	—

Required: name, accountId, clientId, clientSecret.

DELETE /apps/zoom

Delete Zoom accounts.

Auth apikey · Success 200

:::note Used by the web app components/MemberZoomAssignment.jsx, pages/AddMeeting.jsx, pages/AddZoom.jsx and 1 more :::

Request body — the standard bulk selection: ids, nids, selectAll. Query-string filters apply when selectAll is set.

Response — data is null; the outcome is the status code and message.

GET /apps/zoom/:id

Get Zoom account.

Auth apikey

:::note Used by the web app pages/AddZoom.jsx, pages/ZoomAuthCallback.jsx :::

Path parameters

Name
id	Required

PUT /apps/zoom/:id

Update Zoom account.

Auth apikey · Success 200

:::note Used by the web app pages/AddZoom.jsx, pages/ZoomAuthCallback.jsx :::

Path parameters

Name
id	Required

POST /apps/zoom/redirect

Get Zoom redirect URI.

Auth apikey