How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Pomo

Pomo External Platform API

The external-platform API from Pomo — 175 operation(s) for external-platform.

Documentation Provider Profile APIs.io OpenAPI GitHub

Pomo External Platform API is one of 100 APIs that Pomo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include external-platform. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, authentication docs, and rate-limit docs.

This API exposes 175 operations across 175 paths, and defines 102 schemas. It is described by OpenAPI 3.2.0, at version 0.1.0.

Requests are made against a single base URL, https://api.usepomo.ai.

175 operations 175 paths 102 schemas 5 DELETE86 GET1 PATCH83 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.1.0
Base URL
https://api.usepomo.ai
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Pomo External Platform API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (HTTPBearer).

Paths & Operations 175

Across 175 paths, the API surfaces 175 operations — 5 DELETE, 86 GET, 1 PATCH, 83 POST. Each is listed below with its method, path, parameters, and response codes.

external-platform 175
GET
/api/external-platform/instagram/auth
Instagram Auth
instagram_auth_api_external_platform_instagram_auth_get 1 param → 200422
GET
/api/external-platform/instagram/callback
Instagram Callback
instagram_callback_api_external_platform_instagram_callback_get 5 params → 200422
POST
/api/external-platform/instagram/disconnect
Disconnect Instagram
disconnect_instagram_api_external_platform_instagram_disconnect_post → 200
POST
/api/external-platform/instagram/create-post
Create Instagram Post
create_instagram_post_api_external_platform_instagram_create_post_post body → 200422
POST
/api/external-platform/instagram/delete-post
Delete Instagram Post
delete_instagram_post_api_external_platform_instagram_delete_post_post body → 200422
GET
/api/external-platform/instagram/posts
Get Instagram Posts
get_instagram_posts_api_external_platform_instagram_posts_get 2 params → 200422
POST
/api/external-platform/instagram/post-metrics
Get Post Metrics
get_post_metrics_api_external_platform_instagram_post_metrics_post body → 200422
POST
/api/external-platform/instagram/batch-post-metrics
Get Batch Post Metrics
get_batch_post_metrics_api_external_platform_instagram_batch_post_metrics_post body → 200422
GET
/api/external-platform/instagram/accounts
Get Instagram Accounts
get_instagram_accounts_api_external_platform_instagram_accounts_get → 200
GET
/api/external-platform/instagram/activation
Get Instagram Activation
get_instagram_activation_api_external_platform_instagram_activation_get → 200
POST
/api/external-platform/instagram/activate
Activate Instagram Identity
activate_instagram_identity_api_external_platform_instagram_activate_post body → 200422
POST
/api/external-platform/instagram/post-campaign
Post Campaign To Instagram
post_campaign_to_instagram_api_external_platform_instagram_post_campaign_post body → 200422
GET
/api/external-platform/meta/campaign/{campaign_id}/status
Get Meta Campaign Status
get_meta_campaign_status_api_external_platform_meta_campaign__campaign_id__status_get 3 params → 200422
GET
/api/external-platform/meta/auth
Meta Auth
meta_auth_api_external_platform_meta_auth_get 2 params → 200422
GET
/api/external-platform/meta/callback
Meta Callback
meta_callback_api_external_platform_meta_callback_get 4 params → 200422
GET
/api/external-platform/meta/accounts
Get Meta Accounts
get_meta_accounts_api_external_platform_meta_accounts_get → 200
GET
/api/external-platform/meta/activation
Get Meta Activation
get_meta_activation_api_external_platform_meta_activation_get → 200
POST
/api/external-platform/meta/disconnect
Disconnect Meta Ads
disconnect_meta_ads_api_external_platform_meta_disconnect_post → 200
POST
/api/external-platform/meta/accounts/select
Select Meta Ad Account
select_meta_ad_account_api_external_platform_meta_accounts_select_post body → 200422
POST
/api/external-platform/meta/activate
Activate Meta Ad Account
activate_meta_ad_account_api_external_platform_meta_activate_post body → 200422
POST
/api/external-platform/meta/launch-ad-campaign
Launch Meta Ad Campaign
launch_meta_ad_campaign_api_external_platform_meta_launch_ad_campaign_post body → 202422
POST
/api/external-platform/meta/sync-ad-campaign/preview
Preview Meta Sync
preview_meta_sync_api_external_platform_meta_sync_ad_campaign_preview_post body → 200422
POST
/api/external-platform/meta/sync-ad-campaign
Sync Meta Ad Campaign
sync_meta_ad_campaign_api_external_platform_meta_sync_ad_campaign_post body → 202422
GET
/api/external-platform/meta/sync-job/{job_id}
Get Sync Job Status
get_sync_job_status_api_external_platform_meta_sync_job__job_id__get 1 param → 200422
GET
/api/external-platform/meta/launch-job/{job_id}
Get Launch Job Status
get_launch_job_status_api_external_platform_meta_launch_job__job_id__get 1 param → 200422
POST
/api/external-platform/meta/campaigns/{campaign_id}/activate
Activate Meta Campaign
activate_meta_campaign_api_external_platform_meta_campaigns__campaign_id__activate_post 1 param → 200422
POST
/api/external-platform/meta/adsets/{adset_id}/activate
Activate Meta Adset
activate_meta_adset_api_external_platform_meta_adsets__adset_id__activate_post 1 param → 200422
POST
/api/external-platform/meta/ads/{ad_id}/activate
Activate Meta Ad
activate_meta_ad_api_external_platform_meta_ads__ad_id__activate_post 1 param → 200422
POST
/api/external-platform/meta/adsets/{adset_id}/pause
Pause Meta Adset
pause_meta_adset_api_external_platform_meta_adsets__adset_id__pause_post 1 param → 200422
POST
/api/external-platform/meta/ads/{ad_id}/pause
Pause Meta Ad
pause_meta_ad_api_external_platform_meta_ads__ad_id__pause_post 1 param → 200422
POST
/api/external-platform/meta/campaigns/{campaign_id}/pause
Pause Meta Campaign
pause_meta_campaign_api_external_platform_meta_campaigns__campaign_id__pause_post 1 param → 200422
GET
/api/external-platform/meta/campaigns/{campaign_id}/insights
Get Meta Campaign Insights
get_meta_campaign_insights_api_external_platform_meta_campaigns__campaign_id__insights_get 2 params → 200422
POST
/api/external-platform/meta/campaign/action
Meta Campaign Action
meta_campaign_action_api_external_platform_meta_campaign_action_post body → 200422
POST
/api/external-platform/meta/campaign/resume
Meta Campaign Resume
meta_campaign_resume_api_external_platform_meta_campaign_resume_post body → 200422
GET
/api/external-platform/google/auth
Google Auth
google_auth_api_external_platform_google_auth_get → 200
GET
/api/external-platform/google/callback
Google Callback
google_callback_api_external_platform_google_callback_get 2 params → 200422
GET
/api/external-platform/google/accounts
Get Google Accounts
get_google_accounts_api_external_platform_google_accounts_get → 200
GET
/api/external-platform/google/activation
Get Google Activation
get_google_activation_api_external_platform_google_activation_get → 200
POST
/api/external-platform/google/activate
Activate Google Ads Account
activate_google_ads_account_api_external_platform_google_activate_post body → 200422
POST
/api/external-platform/google/disconnect
Disconnect Google Ads
disconnect_google_ads_api_external_platform_google_disconnect_post → 200
POST
/api/external-platform/google/campaigns
Create Google Ad Campaign
create_google_ad_campaign_api_external_platform_google_campaigns_post body → 200422
POST
/api/external-platform/google/ad-groups
Create Google Ad Group
create_google_ad_group_api_external_platform_google_ad_groups_post body → 200422
POST
/api/external-platform/google/display-ads
Create Google Display Ad
create_google_display_ad_api_external_platform_google_display_ads_post body → 200422
POST
/api/external-platform/google/create-ad
Create Ad From Campaign
create_ad_from_campaign_api_external_platform_google_create_ad_post body → 200422
POST
/api/external-platform/google/sync-ad-campaign/preview
Preview Google Sync
preview_google_sync_api_external_platform_google_sync_ad_campaign_preview_post body → 200422
POST
/api/external-platform/google/sync-ad-campaign
Sync Ad Campaign
sync_ad_campaign_api_external_platform_google_sync_ad_campaign_post body → 202422
POST
/api/external-platform/google/launch-ad-campaign
Launch Ad Campaign
launch_ad_campaign_api_external_platform_google_launch_ad_campaign_post body → 202422
POST
/api/external-platform/google/campaign/action
Google Campaign Action
google_campaign_action_api_external_platform_google_campaign_action_post body → 200422
POST
/api/external-platform/google/campaign/resume
Google Campaign Resume
google_campaign_resume_api_external_platform_google_campaign_resume_post body → 200422
GET
/api/external-platform/google/campaign/{campaign_id}/status
Get Google Campaign Status
get_google_campaign_status_api_external_platform_google_campaign__campaign_id__status_get 2 params → 200422
GET
/api/external-platform/amazon/auth
Amazon Auth
amazon_auth_api_external_platform_amazon_auth_get → 200
GET
/api/external-platform/amazon/callback
Amazon Callback
amazon_callback_api_external_platform_amazon_callback_get 2 params → 200422
GET
/api/external-platform/amazon/accounts
Get Amazon Accounts
get_amazon_accounts_api_external_platform_amazon_accounts_get → 200
POST
/api/external-platform/amazon/campaigns
Create Amazon Campaign
create_amazon_campaign_api_external_platform_amazon_campaigns_post body → 200422
POST
/api/external-platform/amazon/ad-groups
Create Amazon Ad Group
create_amazon_ad_group_api_external_platform_amazon_ad_groups_post body → 200422
POST
/api/external-platform/amazon/product-ads
Create Amazon Product Ad
create_amazon_product_ad_api_external_platform_amazon_product_ads_post body → 200422
POST
/api/external-platform/amazon/keywords
Add Amazon Keywords
add_amazon_keywords_api_external_platform_amazon_keywords_post body → 200422
GET
/api/external-platform/amazon/campaigns/{profile_id}
Get Amazon Campaigns
get_amazon_campaigns_api_external_platform_amazon_campaigns__profile_id__get 2 params → 200422
POST
/api/external-platform/amazon/metrics
Get Amazon Campaign Metrics
get_amazon_campaign_metrics_api_external_platform_amazon_metrics_post body → 200422
POST
/api/external-platform/amazon/campaign/action
Amazon Campaign Action
amazon_campaign_action_api_external_platform_amazon_campaign_action_post body → 200422
POST
/api/external-platform/amazon/campaign/resume
Amazon Campaign Resume
amazon_campaign_resume_api_external_platform_amazon_campaign_resume_post body → 200422
GET
/api/external-platform/tiktok/auth
Tiktok Auth
tiktok_auth_api_external_platform_tiktok_auth_get → 200
GET
/api/external-platform/tiktok/callback
Tiktok Callback
tiktok_callback_api_external_platform_tiktok_callback_get 2 params → 200422
GET
/api/external-platform/tiktok/accounts
Get Tiktok Accounts
get_tiktok_accounts_api_external_platform_tiktok_accounts_get → 200
GET
/api/external-platform/tiktok/activation
Get Tiktok Activation
get_tiktok_activation_api_external_platform_tiktok_activation_get → 200
POST
/api/external-platform/tiktok/activate
Activate Tiktok Ads Account
activate_tiktok_ads_account_api_external_platform_tiktok_activate_post body → 200422
POST
/api/external-platform/tiktok/disconnect
Disconnect Tiktok Ads
disconnect_tiktok_ads_api_external_platform_tiktok_disconnect_post → 200
POST
/api/external-platform/tiktok/launch-video-ad
Launch Tiktok Video Ad
launch_tiktok_video_ad_api_external_platform_tiktok_launch_video_ad_post body → 202422
POST
/api/external-platform/tiktok/sync-ad-campaign/preview
Preview Tiktok Sync
preview_tiktok_sync_api_external_platform_tiktok_sync_ad_campaign_preview_post body → 200422
POST
/api/external-platform/tiktok/sync-ad-campaign
Sync Tiktok Ad Campaign
sync_tiktok_ad_campaign_api_external_platform_tiktok_sync_ad_campaign_post body → 202422
POST
/api/external-platform/tiktok/ad/pause
Pause Tiktok Ad
pause_tiktok_ad_api_external_platform_tiktok_ad_pause_post body → 200422
POST
/api/external-platform/tiktok/ad/resume
Resume Tiktok Ad
resume_tiktok_ad_api_external_platform_tiktok_ad_resume_post body → 200422
GET
/api/external-platform/tiktok-social/auth
Tiktok Social Auth
tiktok_social_auth_api_external_platform_tiktok_social_auth_get → 200
GET
/api/external-platform/tiktok-social/callback
Tiktok Social Callback
tiktok_social_callback_api_external_platform_tiktok_social_callback_get 4 params → 200422
GET
/api/external-platform/tiktok-social/status
Tiktok Social Status
tiktok_social_status_api_external_platform_tiktok_social_status_get → 200
GET
/api/external-platform/tiktok-social/accounts
Tiktok Social Accounts
tiktok_social_accounts_api_external_platform_tiktok_social_accounts_get → 200
POST
/api/external-platform/tiktok-social/creator-info
Tiktok Social Creator Info
tiktok_social_creator_info_api_external_platform_tiktok_social_creator_info_post → 200
POST
/api/external-platform/tiktok-social/publish-settings
Save Tiktok Social Publish Settings
save_tiktok_social_publish_settings_api_external_platform_tiktok_social_publish_settings_post body → 200422
POST
/api/external-platform/tiktok-social/post-campaign
Post Campaign To Tiktok Social
post_campaign_to_tiktok_social_api_external_platform_tiktok_social_post_campaign_post body → 200422
GET
/api/external-platform/tiktok-social/publish-status/{publish_id}
Tiktok Social Publish Status
tiktok_social_publish_status_api_external_platform_tiktok_social_publish_status__publish_id__get 1 param → 200422
POST
/api/external-platform/tiktok-social/disconnect
Disconnect Tiktok Social
disconnect_tiktok_social_api_external_platform_tiktok_social_disconnect_post → 200
GET
/api/external-platform/linkedin/auth
Linkedin Auth
linkedin_auth_api_external_platform_linkedin_auth_get 1 param → 200422
GET
/api/external-platform/linkedin/callback
Linkedin Callback
linkedin_callback_api_external_platform_linkedin_callback_get 4 params → 200422
GET
/api/external-platform/linkedin/accounts
Get Linkedin Ad Accounts
get_linkedin_ad_accounts_api_external_platform_linkedin_accounts_get → 200
GET
/api/external-platform/linkedin/activation
Get Linkedin Ads Activation
get_linkedin_ads_activation_api_external_platform_linkedin_activation_get → 200
POST
/api/external-platform/linkedin/activate
Activate Linkedin Ads Account
activate_linkedin_ads_account_api_external_platform_linkedin_activate_post body → 200422
POST
/api/external-platform/linkedin/campaign/action
Linkedin Campaign Action
linkedin_campaign_action_api_external_platform_linkedin_campaign_action_post body → 200422
POST
/api/external-platform/linkedin/campaign/resume
Linkedin Campaign Resume
linkedin_campaign_resume_api_external_platform_linkedin_campaign_resume_post body → 200422
POST
/api/external-platform/linkedin/sync-ad-campaign/preview
Preview Linkedin Sync
preview_linkedin_sync_api_external_platform_linkedin_sync_ad_campaign_preview_post body → 200422
POST
/api/external-platform/linkedin/sync-ad-campaign
Sync Linkedin Ad Campaign
sync_linkedin_ad_campaign_api_external_platform_linkedin_sync_ad_campaign_post body → 202422
POST
/api/external-platform/linkedin/launch-image-ad
Launch Linkedin Image Ad
launch_linkedin_image_ad_api_external_platform_linkedin_launch_image_ad_post body → 202422
POST
/api/external-platform/linkedin/launch-video-ad
Launch Linkedin Video Ad
launch_linkedin_video_ad_api_external_platform_linkedin_launch_video_ad_post body → 202422
GET
/api/external-platform/linkedin/status
Linkedin Ads Status
linkedin_ads_status_api_external_platform_linkedin_status_get → 200
POST
/api/external-platform/linkedin/disconnect
Disconnect Linkedin Ads
disconnect_linkedin_ads_api_external_platform_linkedin_disconnect_post → 200
GET
/api/external-platform/linkedin-social/auth
Linkedin Social Auth
linkedin_social_auth_api_external_platform_linkedin_social_auth_get → 200
GET
/api/external-platform/linkedin-social/status
Linkedin Social Status
linkedin_social_status_api_external_platform_linkedin_social_status_get → 200
GET
/api/external-platform/linkedin-social/accounts
Linkedin Social Accounts
linkedin_social_accounts_api_external_platform_linkedin_social_accounts_get → 200
POST
/api/external-platform/linkedin/post-campaign
Post Campaign To Linkedin
post_campaign_to_linkedin_api_external_platform_linkedin_post_campaign_post body → 200422
POST
/api/external-platform/linkedin/delete-campaign-post
Delete Campaign Post From Linkedin
delete_campaign_post_from_linkedin_api_external_platform_linkedin_delete_campaign_post_post body → 200422
POST
/api/external-platform/linkedin/sync-post-status
Sync Linkedin Campaign Post Status
sync_linkedin_campaign_post_status_api_external_platform_linkedin_sync_post_status_post body → 200422
POST
/api/external-platform/linkedin-social/disconnect
Disconnect Linkedin Social
disconnect_linkedin_social_api_external_platform_linkedin_social_disconnect_post → 200
GET
/api/external-platform/shopify/callback
Shopify Callback
shopify_callback_api_external_platform_shopify_callback_get 6 params → 200422
GET
/api/external-platform/shopify/install
Shopify Install
shopify_install_api_external_platform_shopify_install_get 4 params → 200422
GET
/api/external-platform/shopify/install/launch
Shopify Install Launch
shopify_install_launch_api_external_platform_shopify_install_launch_get 1 param → 200422
POST
/api/external-platform/shopify/connect/start
Shopify Connect Start
shopify_connect_start_api_external_platform_shopify_connect_start_post body → 200422
POST
/api/external-platform/shopify/install/resolve
Shopify Install Resolve
shopify_install_resolve_api_external_platform_shopify_install_resolve_post body → 200422
POST
/api/external-platform/shopify/privacy/webhooks
Shopify Privacy Webhook
shopify_privacy_webhook_api_external_platform_shopify_privacy_webhooks_post → 200
POST
/api/external-platform/shopify/webhooks/app-uninstalled
Shopify App Uninstalled Webhook
shopify_app_uninstalled_webhook_api_external_platform_shopify_webhooks_app_uninstalled_post → 200
GET
/api/external-platform/shopify/shop
Get Shopify Shop
get_shopify_shop_api_external_platform_shopify_shop_get → 200
GET
/api/external-platform/shopify/status
Get Shopify Status
get_shopify_status_api_external_platform_shopify_status_get 1 param → 200422
GET
/api/external-platform/shopify/orders
Get Shopify Orders
get_shopify_orders_api_external_platform_shopify_orders_get 2 params → 200422
DELETE
/api/external-platform/shopify/disconnect
Disconnect Shopify
disconnect_shopify_api_external_platform_shopify_disconnect_delete → 200
GET
/api/external-platform/shopify/app-home
Shopify App Home
shopify_app_home_api_external_platform_shopify_app_home_get 2 params → 200422
GET
/api/external-platform/shopify/app/status
Shopify App Status
shopify_app_status_api_external_platform_shopify_app_status_get → 200
POST
/api/external-platform/shopify/app/sync
Shopify App Sync
shopify_app_sync_api_external_platform_shopify_app_sync_post → 200
POST
/api/external-platform/shopify/app/begin-install
Shopify App Begin Install
shopify_app_begin_install_api_external_platform_shopify_app_begin_install_post → 200
GET
/api/external-platform/stripe/auth
Stripe Auth
stripe_auth_api_external_platform_stripe_auth_get 1 param → 200422
GET
/api/external-platform/stripe/callback
Stripe Callback
stripe_callback_api_external_platform_stripe_callback_get 4 params → 200422
GET
/api/external-platform/stripe/account
Get Stripe Account
get_stripe_account_api_external_platform_stripe_account_get → 200
GET
/api/external-platform/stripe/status
Get Stripe Status
get_stripe_status_api_external_platform_stripe_status_get 1 param → 200422
GET
/api/external-platform/stripe/transactions
Get Stripe Transactions
get_stripe_transactions_api_external_platform_stripe_transactions_get 2 params → 200422
DELETE
/api/external-platform/stripe/disconnect
Disconnect Stripe
disconnect_stripe_api_external_platform_stripe_disconnect_delete → 200
GET
/api/external-platform/quickbooks/auth
Quickbooks Auth
quickbooks_auth_api_external_platform_quickbooks_auth_get → 200
GET
/api/external-platform/quickbooks/callback
Quickbooks Callback
quickbooks_callback_api_external_platform_quickbooks_callback_get 5 params → 200422
GET
/api/external-platform/quickbooks/account
Get Quickbooks Account
get_quickbooks_account_api_external_platform_quickbooks_account_get → 200
GET
/api/external-platform/quickbooks/status
Get Quickbooks Status
get_quickbooks_status_api_external_platform_quickbooks_status_get 1 param → 200422
DELETE
/api/external-platform/quickbooks/disconnect
Disconnect Quickbooks
disconnect_quickbooks_api_external_platform_quickbooks_disconnect_delete → 200
GET
/api/external-platform/quickbooks/initial-sync-status
Get Initial Sync Status
get_initial_sync_status_api_external_platform_quickbooks_initial_sync_status_get → 200
GET
/api/external-platform/google-analytics/auth
Google Analytics Auth
google_analytics_auth_api_external_platform_google_analytics_auth_get → 200
GET
/api/external-platform/google-analytics/callback
Google Analytics Callback
google_analytics_callback_api_external_platform_google_analytics_callback_get 4 params → 200422
GET
/api/external-platform/google-analytics/status
Get Google Analytics Status
get_google_analytics_status_api_external_platform_google_analytics_status_get 1 param → 200422
GET
/api/external-platform/google-analytics/properties
Get Google Analytics Properties
get_google_analytics_properties_api_external_platform_google_analytics_properties_get 1 param → 200422
POST
/api/external-platform/google-analytics/properties/select
Select Google Analytics Property
select_google_analytics_property_api_external_platform_google_analytics_properties_select_post body → 200422
DELETE
/api/external-platform/google-analytics/disconnect
Disconnect Google Analytics
disconnect_google_analytics_api_external_platform_google_analytics_disconnect_delete → 200
GET
/api/external-platform/google-analytics/initial-sync-status
Get Google Analytics Initial Sync Status
get_google_analytics_initial_sync_status_api_external_platform_google_analytics_initial_sync_status_get → 200
GET
/api/external-platform/square/auth
Square Auth
square_auth_api_external_platform_square_auth_get 1 param → 200422
GET
/api/external-platform/square/callback
Square Callback
square_callback_api_external_platform_square_callback_get 4 params → 200422
POST
/api/external-platform/square/webhooks
Square Webhook
square_webhook_api_external_platform_square_webhooks_post → 200
GET
/api/external-platform/square/status
Get Square Status
get_square_status_api_external_platform_square_status_get 1 param → 200422
GET
/api/external-platform/square/accounts
Get Square Accounts
get_square_accounts_api_external_platform_square_accounts_get → 200
DELETE
/api/external-platform/square/disconnect
Disconnect Square
disconnect_square_api_external_platform_square_disconnect_delete → 200
GET
/api/external-platform/klaviyo/auth
Klaviyo Auth
klaviyo_auth_api_external_platform_klaviyo_auth_get → 200
GET
/api/external-platform/klaviyo/callback
Klaviyo Callback
klaviyo_callback_api_external_platform_klaviyo_callback_get 4 params → 200422
GET
/api/external-platform/klaviyo/accounts
Get Klaviyo Accounts
get_klaviyo_accounts_api_external_platform_klaviyo_accounts_get → 200
GET
/api/external-platform/klaviyo/status
Get Klaviyo Status
get_klaviyo_status_api_external_platform_klaviyo_status_get → 200
GET
/api/external-platform/klaviyo/health
Get Klaviyo Health
get_klaviyo_health_api_external_platform_klaviyo_health_get → 200
POST
/api/external-platform/klaviyo/disconnect
Disconnect Klaviyo
disconnect_klaviyo_api_external_platform_klaviyo_disconnect_post → 200
GET
/api/external-platform/{platform}/initial-sync-status
Get Provider Initial Sync Status
get_provider_initial_sync_status_api_external_platform__platform__initial_sync_status_get 1 param → 200422
GET
/api/external-platform/slack/auth
Slack Auth
slack_auth_api_external_platform_slack_auth_get → 200
GET
/api/external-platform/slack/callback
Slack Callback
slack_callback_api_external_platform_slack_callback_get 4 params → 200422
GET
/api/external-platform/slack/status
Slack Status
slack_status_api_external_platform_slack_status_get → 200
GET
/api/external-platform/slack/channels
List Slack Channels
list_slack_channels_api_external_platform_slack_channels_get → 200
PATCH
/api/external-platform/slack/settings
Update Slack Settings
update_slack_settings_api_external_platform_slack_settings_patch body → 200422
POST
/api/external-platform/slack/link
Link Slack Identity
link_slack_identity_api_external_platform_slack_link_post body → 200422
POST
/api/external-platform/slack/test-message
Slack Test Message
slack_test_message_api_external_platform_slack_test_message_post body → 200422
POST
/api/external-platform/slack/campaign-card
Slack Campaign Card
slack_campaign_card_api_external_platform_slack_campaign_card_post body → 200422
POST
/api/external-platform/slack/disconnect
Slack Disconnect
slack_disconnect_api_external_platform_slack_disconnect_post → 200
POST
/api/external-platform/slack/events
Slack Events
slack_events_api_external_platform_slack_events_post → 200
POST
/api/external-platform/slack/interactions
Slack Interactions
slack_interactions_api_external_platform_slack_interactions_post → 200
POST
/api/external-platform/slack/commands
Slack Commands
slack_commands_api_external_platform_slack_commands_post → 200
GET
/api/external-platform/facebook-social/auth
Facebook Social Auth
facebook_social_auth_api_external_platform_facebook_social_auth_get → 200
GET
/api/external-platform/facebook-social/callback
Facebook Social Callback
facebook_social_callback_api_external_platform_facebook_social_callback_get 4 params → 200422
GET
/api/external-platform/facebook-social/status
Facebook Social Status
facebook_social_status_api_external_platform_facebook_social_status_get → 200
GET
/api/external-platform/facebook-social/pages
Get Facebook Pages
get_facebook_pages_api_external_platform_facebook_social_pages_get → 200
GET
/api/external-platform/facebook-social/activation
Get Facebook Social Activation
get_facebook_social_activation_api_external_platform_facebook_social_activation_get → 200
POST
/api/external-platform/facebook-social/activate
Activate Facebook Social Page
activate_facebook_social_page_api_external_platform_facebook_social_activate_post body → 200422
POST
/api/external-platform/facebook-social/disconnect
Disconnect Facebook Social
disconnect_facebook_social_api_external_platform_facebook_social_disconnect_post → 200
POST
/api/external-platform/facebook-social/post-campaign
Post Campaign To Facebook
post_campaign_to_facebook_api_external_platform_facebook_social_post_campaign_post body → 200422
POST
/api/external-platform/facebook-social/delete-post
Delete Facebook Story Post
delete_facebook_story_post_api_external_platform_facebook_social_delete_post_post body → 200422
GET
/api/external-platform/hubspot/auth
Hubspot Auth
hubspot_auth_api_external_platform_hubspot_auth_get → 200
GET
/api/external-platform/hubspot/callback
Hubspot Callback
hubspot_callback_api_external_platform_hubspot_callback_get 4 params → 200422
GET
/api/external-platform/hubspot/status
Get Hubspot Status
get_hubspot_status_api_external_platform_hubspot_status_get → 200
GET
/api/external-platform/hubspot/health
Get Hubspot Health
get_hubspot_health_api_external_platform_hubspot_health_get → 200
POST
/api/external-platform/hubspot/disconnect
Disconnect Hubspot
disconnect_hubspot_api_external_platform_hubspot_disconnect_post → 200
GET
/api/external-platform/hubspot/initial-sync-status
Hubspot Initial Sync Status
hubspot_initial_sync_status_api_external_platform_hubspot_initial_sync_status_get → 200

Schemas 102

The contract defines 102 schemas that model the data the API accepts and returns. The most detailed are SlackStatusResponse (16 properties), GoogleAnalyticsStatusResponseModel (16 properties), SquareStatusResponseModel (14 properties), TikTokSocialPublishSettings (11 properties). Each schema is shown below with its type and property counts.

SlackLinkResponse
object
3 properties 3 required
TikTokAuthResponseModel
object
1 property 1 required
KlaviyoAccountsResponse
object
Response model for Klaviyo lists/segments.
1 property 1 required
MetaSyncPreviewRequest
object
Request model for previewing a Meta sync and billing impact.
5 properties 2 required
SlackChannelResponse
object
4 properties 2 required
AmazonKeywordsRequest
object
3 properties 3 required
SquareStatusResponseModel
object
Response model for Square connection status with health check.
14 properties 1 required
GoogleLaunchAdCampaignRequest
object
Request model for launching an online ad campaign to Google Ads.
6 properties 2 required
KlaviyoHealthResponse
object
Response model for connection health status.
1 property 1 required
GoogleAccountsResponseModel
object
3 properties 1 required
MetaSyncAdCampaignRequest
object
Request model for syncing an online ad campaign to Meta.
5 properties 2 required
AmazonCampaignRequest
object
7 properties 2 required
AmazonCampaignActionRequest
object
Request model for pausing/deleting an Amazon campaign.
4 properties 4 required
InitialSyncStatusResponse
object
Standard response for initial data-source sync status. Used by: GET /{platform}/initial-sync-status
5 properties 1 required
routes__external_platform__google_action__GoogleDisplayAdRequest
object
Request model for creating a Google Display ad.
8 properties 7 required
StripeStatusResponseModel
object
Response model for connection status with health check.
10 properties 1 required
MetaSelectAdAccountRequest
object
3 properties 1 required
DataSourceAuthResponse
object
Standard response for OAuth authorization URL endpoint. Used by: GET /{platform}/auth
1 property 1 required
GoogleAnalyticsPropertySelectResponse
object
3 properties 3 required
DeletePostResponseModel
object
Response model for Instagram post deletion.
1 property 1 required
ShopifyConnectStartRequestModel
object
Pomo-initiated on-ramp request.
1 property
TikTokSocialPostCampaignRequest
object
5 properties 3 required
MetaAccountsResponseModel
object
5 properties 1 required
AppHomeSyncResponse
object
Result of a catalog re-sync triggered from the App Home.
2 properties 2 required
AmazonProductAdRequest
object
3 properties 3 required
DataSourceTransactionsResponse
object
Response for transactions list endpoint. Used by: GET /stripe/transactions, GET /square/payments
3 properties
KlaviyoAuthResponse
object
Response model for Klaviyo auth URL.
1 property 1 required
AppHomeBeginInstallResponse
object
Shopify OAuth authorize URL for (re)running the install handshake.
1 property 1 required
DataSourceLocationsResponse
object
Response for locations/accounts list endpoint. Used by: GET /{platform}/accounts or GET /{platform}/locations
1 property
GoogleAnalyticsProperty
object
6 properties 3 required
TikTokSyncPreviewRequest
object
Request model for previewing a TikTok normalized sync.
3 properties 1 required
LinkedInActivateAccountRequest
object
2 properties 2 required
GoogleSyncAdCampaignRequest
object
Request model for syncing an online ad campaign to Google Ads.
5 properties 2 required
DataSourceDisconnectResponse
object
Standard response for disconnect endpoint. Used by: DELETE /{platform}/disconnect or POST /{platform}/disconnect
2 properties 2 required
TikTokSyncAdRequest
object
Request model for syncing saved Pomo changes to a TikTok ad baseline.
3 properties 1 required
GoogleAnalyticsPropertySelectRequest
object
1 property 1 required
JobResponse
object
Response after submitting a job
4 properties 4 required
FacebookSocialActivateRequest
object
1 property 1 required
GoogleAuthResponseModel
object
1 property 1 required
TikTokAccountsResponseModel
object
3 properties 1 required
HubSpotHealthResponse
object
Response model for the HubSpot connection health status.
1 property 1 required
AppHomeStatusResponse
object
Status of an embedded shop as seen from the App Home. bound is the primary discriminator: when false the shop has no active Pomo binding and every profile-rela…
10 properties 2 required
BatchPostMetricsRequest
object
Request model for getting metrics for multiple Instagram posts.
2 properties 2 required
LinkedInLaunchVideoAdRequest
object
6 properties 1 required
GoogleAdGroupRequest
object
3 properties 3 required
HubSpotStatusResponse
object
Response model for the HubSpot connection status.
4 properties 1 required
LinkedInCampaignActionRequest
object
4 properties 3 required
MetaLaunchAdCampaignRequest
object
Request model for launching a Meta ad campaign
7 properties 2 required
GoogleAnalyticsStatusResponseModel
object
16 properties 1 required
ShopifyShopResponseModel
object
Response model for shop information.
3 properties 1 required
TikTokLaunchVideoAdRequest
object
Request model for launching a TikTok video ad with optional text field overrides
5 properties 1 required
DataSourceAccountInfo
object
Standard account information model. Used by: GET /{platform}/account or embedded in other responses
6 properties 1 required
MetaCampaignActionRequest
object
Request model for pausing/deleting a Meta campaign.
4 properties 4 required
SlackSettingsUpdateRequest
object
2 properties
HTTPValidationError
object
1 property
LinkedInSyncPreviewRequest
object
4 properties 2 required
TikTokAdStatusResponse
object
Response model for ad status update operations
3 properties 3 required
GoogleCreateAdFromCampaignRequest
object
4 properties 3 required
GoogleSyncPreviewRequest
object
Request model for previewing a sync and billing impact.
5 properties 2 required
MetaAuthResponseModel
object
2 properties 2 required
SlackLinkRequest
object
3 properties 1 required
TikTokSocialPublishSettingsRequest
object
4 properties 3 required
LinkedInLeadFormConfig
object
6 properties 5 required
TikTokAdPauseRequest
object
Request model for pausing a TikTok ad
2 properties 2 required
HubSpotAuthResponse
object
Response model for the HubSpot auth URL.
1 property 1 required
LinkedInLaunchImageAdRequest
object
6 properties 1 required
CreatePostRequest
object
Request model for creating an Instagram post.
4 properties 3 required
SlackTestMessageRequest
object
2 properties
QuickBooksStatusResponseModel
object
Connection status with optional health check.
9 properties 1 required
ValidationError
object
3 properties 3 required
DataSourceLocation
object
Location model for platforms with multiple locations. Used by: Square, Shopify (locations)
6 properties 2 required
SlackChannelsListResponse
object
1 property
MetaCampaignResumeRequest
object
Request model for resuming a Meta campaign (no action field).
3 properties 3 required
ShopifyStatusResponseModel
object
Response model for connection status with health check.
9 properties 1 required
InstagramPostCampaignRequest
object
7 properties 3 required
PostResponseModel
object
Response model for created Instagram post.
1 property 1 required
SlackCampaignCardRequest
object
4 properties
FacebookPostCampaignRequest
object
5 properties 3 required
LinkedInCampaignPostRequest
object
3 properties 2 required
DeletePostRequest
object
Request model for deleting an Instagram post.
2 properties 1 required
InstagramAuthResponseModel
object
Response model for Instagram authorization URL.
1 property 1 required
LinkedInCampaignResumeRequest
object
3 properties 2 required
AmazonAdGroupRequest
object
4 properties 3 required
LinkedInSyncAdCampaignRequest
object
4 properties 2 required
InstagramActivateIdentityRequest
object
2 properties 1 required
TikTokAdResumeRequest
object
Request model for resuming a TikTok ad
2 properties 2 required
GoogleCampaignActionRequest
object
Request model for pausing/deleting a Google campaign.
4 properties 4 required
DataSourceOrdersResponse
object
Response for orders list endpoint. Used by: GET /shopify/orders
3 properties
AmazonAccountsResponseModel
object
1 property 1 required
DataSourceAccountResponse
object
Response for account information endpoint. Used by: GET /{platform}/account
2 properties 1 required
TikTokSocialPublishSettings
object
11 properties 1 required
KlaviyoList
object
Klaviyo list/segment model.
6 properties 2 required
PostMetricsRequest
object
Request model for getting Instagram post metrics.
2 properties 1 required
TikTokActivateAccountRequest
object
1 property 1 required
GoogleAdCampaignRequest
object
5 properties 4 required
KlaviyoStatusResponse
object
Response model for Klaviyo connection status.
5 properties 1 required
ShopifyInstallResolveRequestModel
object
5 properties
LinkedInPostCampaignRequest
object
4 properties 2 required
SlackStatusResponse
object
16 properties 1 required
GoogleActivateAccountRequest
object
1 property 1 required
AmazonAuthResponseModel
object
1 property 1 required
GoogleAnalyticsPropertiesResponse
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

pomo-external-platform-api-openapi.yml Raw ↑

Other APIs Pomo publishes across the network.

Pomo Ab Groups API
AE Profile APIs.io
Pomo Agent Jobs API
AE Profile APIs.io
Pomo Agentic Chat API
AE Profile APIs.io
Pomo Agentic Conversations API
AE Profile APIs.io
Pomo Agentic Tasks API
AE Profile APIs.io
Pomo Agentic Teams API
AE Profile APIs.io
Pomo Agentic User API
AE Profile APIs.io
Pomo AI Campaign API
AE Profile APIs.io
Pomo AI Personas API
AE Profile APIs.io
Pomo AI Policy API
AE Profile APIs.io
Pomo AI Product Lab API
AE Profile APIs.io
Pomo AI Testing API
AE Profile APIs.io
#external-platform
← Back to P APIs
API Details
ID
pomo:pomo-external-platform-api
Base URL
https://api.usepomo.ai
Docs
https://api.usepomo.ai/docs
Provider
Pomo
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=pomo-external-platform-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/pomo-external-platform-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Pomo External Platform API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.