Connections
List account connection handoff options
get/api/v1/connect
Request
- Base URL: https://www.poster.ly
- URL: https://www.poster.ly/api/v1/connect
- Auth: HTTP bearer
Query parameters
workspace_idstring
Filter connected account counts to a workspace.
include_plannedboolean
Include provider expansion possibilities that do not have live connection flows yet.
Response
Connection options fetched successfully
Example response
{
"connect_options": [
{
"platform": "instagram",
"aliases": [
"instagram-standalone",
"instagram_direct"
],
"label": "Instagram",
"status": "supported",
"method": "dashboard_oauth",
"provider_platforms": [
"instagram"
],
"dashboard_url": "https://www.poster.ly/dashboard/connect?platform=instagram",
"connection_url": "https://www.poster.ly/dashboard/connect?platform=instagram",
"oauth_url": null,
"supports_direct_oauth_url": false,
"supports_direct_credentials": false,
"credentials_endpoint": null,
"requires_browser_session": true,
"configured": true,
"env_requirements": [
{
"any_of": [
"NEXT_PUBLIC_INSTAGRAM_APP_ID"
],
"description": "Instagram OAuth app ID"
}
],
"missing_env": [],
"scopes": [
"instagram_business_basic",
"instagram_business_manage_messages",
"instagram_business_manage_comments",
"instagram_business_content_publish",
"instagram_business_manage_insights"
],
"credential_fields": [],
"notes": [
"Starts the direct Instagram login flow from the posterly dashboard.",
"Use this for Instagram publishing, native media tags, caption mentions, inbox, comments, and analytics.",
"Collaborator invitations require an eligible Meta-linked Instagram connection.",
"Use connection_url in a logged-in browser, or create a connect session with POST /api/v1/connect/{platform}/sessions for pollable agent progress. Direct public OAuth URL generation is intentionally not exposed because provider callbacks depend on short-lived browser state."
],
"connected_count": 0,
"connected_accounts": []
},
{
"platform": "meta",
"aliases": [
"facebook_instagram",
"meta_business"
],
"label": "Meta",
"status": "supported",
"method": "dashboard_oauth",
"provider_platforms": [
"facebook",
"instagram"
],
"dashboard_url": "https://www.poster.ly/dashboard/connect?platform=meta",
"connection_url": "https://www.poster.ly/dashboard/connect?platform=meta",
"oauth_url": null,
"supports_direct_oauth_url": false,
"supports_direct_credentials": false,
"credentials_endpoint": null,
"requires_browser_session": true,
"configured": true,
"env_requirements": [
{
"any_of": [
"NEXT_PUBLIC_FACEBOOK_APP_ID"
],
"description": "Meta/Facebook OAuth app ID"
}
],
"missing_env": [],
"scopes": [
"pages_show_list",
"pages_read_engagement",
"pages_read_user_content",
"pages_manage_posts",
"business_management",
"read_insights",
"instagram_basic",
"instagram_content_publish",
"instagram_manage_contents",
"pages_manage_engagement",
"pages_messaging",
"pages_manage_metadata"
],
"credential_fields": [],
"notes": [
"Connects Facebook Pages and linked professional Instagram accounts.",
"Instagram collaborator invitations require this Meta-linked connection and the corresponding publishing permission.",
"The dashboard stores provider mode in a short-lived browser cookie before redirecting to Meta.",
"Use connection_url in a logged-in browser, or create a connect session with POST /api/v1/connect/{platform}/sessions for pollable agent progress. Direct public OAuth URL generation is intentionally not exposed because provider callbacks depend on short-lived browser state."
],
"connected_count": 0,
"connected_accounts": []
},
{
"platform": "facebook",
"aliases": [
"facebook_pages"
],
"label": "Facebook Pages",
"status": "supported",
"method": "dashboard_oauth",
"provider_platforms": [
"facebook"
],
"dashboard_url": "https://www.poster.ly/dashboard/connect?platform=facebook",
"connection_url": "https://www.poster.ly/dashboard/connect?platform=facebook",
"oauth_url": null,
"supports_direct_oauth_url": false,
"supports_direct_credentials": false,
"credentials_endpoint": null,
"requires_browser_session": true,
"configured": true,
"env_requirements": [
{
"any_of": [
"NEXT_PUBLIC_FACEBOOK_APP_ID"
],
"description": "Facebook OAuth app ID"
}
],
"missing_env": [],
"scopes": [
"pages_show_list",
"pages_read_engagement",
"pages_read_user_content",
"pages_manage_posts",
"business_management",
"read_insights"
],
"credential_fields": [],
"notes": [
"Connects Facebook Pages without importing linked Instagram accounts.",
"Use connection_url in a logged-in browser, or create a connect session with POST /api/v1/connect/{platform}/sessions for pollable agent progress. Direct public OAuth URL generation is intentionally not exposed because provider callbacks depend on short-lived browser state."
],
"connected_count": 0,
"connected_accounts": []
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.