---
title: "Get account connect session status"
method: GET
path: "/api/v1/connect/sessions/{session_id}"
tags: ["Connections"]
---

# Get account connect session status

`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

Poll this endpoint after creating a connect session to show progress in the agent conversation.

## Path parameters

- `session_id` string, uuid, required

## Response `200`

Connect session fetched successfully

- ConnectSessionResponse
  - `connect_session` ConnectSession, required
    - `id` string, uuid, required
    - `platform` string, required
    - `method` 'dashboard_oauth' | 'manual_credentials', required
    - `status` 'created' | 'opened' | 'awaiting_provider' | 'awaiting_credentials' | 'connected' | 'failed' | 'cancelled' | 'expired', required
    - `status_message` string, required
    - `connect_url` string, uri, required
    - `poll_url` string, uri, required
    - `workspace_id` string, uuid, nullable, required
    - `connected_account_ids` string[], required
    - `connected_accounts` Account[], required
      - `id` string, required
      - `platform` string, required
      - `username` string, nullable
      - `account_type` string, nullable
      - `profile_picture_url` string, nullable
      - `workspace_id` string, nullable
      - `workspace_client_id` string, nullable
      - `location_id` string, nullable: Google Business only: the numeric location id to pass as location_id to GBP tools. Not the ChIJ... Place ID.
      - `connection_mode` 'meta' | 'instagram_direct', nullable: Instagram only: whether the account is Meta/Facebook-linked or connected with Instagram Login.
      - `instagram_tagging` object, nullable: Instagram only: account-specific support and post-type rules for caption mentions, native media user tags, and collaborators.
    - `connected_count` integer, required
    - `error_code` string, nullable, required
    - `error_message` string, nullable, required
    - `created_at` string, date-time, required
    - `opened_at` string, date-time, nullable
    - `provider_redirected_at` string, date-time, nullable
    - `completed_at` string, date-time, nullable
    - `expires_at` string, date-time, required
  - `connect` ConnectOption
    - `platform` string, required
    - `aliases` string[]
    - `label` string, required
    - `status` 'supported' | 'planned', required
    - `method` 'dashboard_oauth' | 'manual_credentials' | 'planned', required
    - `provider_platforms` string[]
    - `dashboard_url` string, uri, required
    - `connection_url` string, uri, nullable, required
    - `oauth_url` string, uri, nullable, required
    - `supports_direct_oauth_url` boolean, required
    - `supports_direct_credentials` boolean
    - `credentials_endpoint` string, nullable
    - `requires_browser_session` boolean, required
    - `configured` boolean, nullable, required
    - `env_requirements` object[]
    - `missing_env` array[]
      - string[]
    - `scopes` string[]
    - `credential_fields` object[]
    - `notes` string[]
    - `connected_count` integer, required
    - `connected_accounts` Account[], required
      - `id` string, required
      - `platform` string, required
      - `username` string, nullable
      - `account_type` string, nullable
      - `profile_picture_url` string, nullable
      - `workspace_id` string, nullable
      - `workspace_client_id` string, nullable
      - `location_id` string, nullable: Google Business only: the numeric location id to pass as location_id to GBP tools. Not the ChIJ... Place ID.
      - `connection_mode` 'meta' | 'instagram_direct', nullable: Instagram only: whether the account is Meta/Facebook-linked or connected with Instagram Login.
      - `instagram_tagging` object, nullable: Instagram only: account-specific support and post-type rules for caption mentions, native media user tags, and collaborators.

## Other responses

- `401`: Invalid or missing API key
- `404`: Resource not found
- `429`: Too many requests

---

[API](https://skmtc.dev/poster/apis/posterly-api.md) · [All operations](https://skmtc.dev/poster/apis/posterly-api/llms.txt) · [OpenAPI document](https://skmtc.dev/poster/apis/posterly-api/revisions/60be02a61f95?raw)