Connections
Get account connect session status
Poll this endpoint after creating a connect session to show progress in the agent conversation.
get/api/v1/connect/sessions/{session_id}
Request
- Base URL: https://www.poster.ly
- URL: https://www.poster.ly/api/v1/connect/sessions/{session_id}
- Auth: HTTP bearer
Path parameters
session_idstring uuid required
Connect session ID returned by POST /api/v1/connect/{platform}/sessions.
Response
Connect session fetched successfully
Example response
{
"connect_session": {
"id": "8ec5ae8c-fd6b-4e0b-83d7-0f88c3f5e9e1",
"platform": "instagram",
"method": "dashboard_oauth",
"status": "awaiting_provider",
"status_message": "User is approving the provider OAuth connection.",
"connect_url": "https://www.poster.ly/dashboard/connect?platform=instagram&connect_session=8ec5ae8c-fd6b-4e0b-83d7-0f88c3f5e9e1&auto_start=1",
"poll_url": "https://www.poster.ly/api/v1/connect/sessions/8ec5ae8c-fd6b-4e0b-83d7-0f88c3f5e9e1",
"workspace_id": "2d0a6d4c-9eef-4ee2-9026-2ca0dc29c8d6",
"connected_account_ids": [],
"connected_accounts": [],
"connected_count": 0,
"error_code": null,
"error_message": null,
"created_at": "2026-05-19T10:00:00.000Z",
"opened_at": "2026-05-19T10:00:12.000Z",
"provider_redirected_at": "2026-05-19T10:00:18.000Z",
"completed_at": null,
"expires_at": "2026-05-19T10:30:00.000Z"
},
"connect": {
"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": 1,
"connected_accounts": [
{
"id": "123",
"platform": "instagram",
"username": "thebrightlabuae",
"account_type": "profile",
"connection_mode": "instagram_direct"
}
]
}
}Changes
No recorded changes to this operation across all 1 revision of this API.