---
title: "Get a dashboard connection handoff for one platform"
method: GET
path: "/api/v1/connect/{platform}"
tags: ["Connections"]
---

# Get a dashboard connection handoff for one platform

`GET /api/v1/connect/{platform}`

## Request

- Base URL: `https://www.poster.ly`
- URL: `https://www.poster.ly/api/v1/connect/{platform}`
- Auth: HTTP bearer

## Path parameters

- `platform` string, required

## Query parameters

- `workspace_id` string
- `include_planned` boolean

## Response `200`

Connection handoff fetched successfully

- ConnectOptionResponse
  - `connect` ConnectOption, required
    - `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

- `400`: Validation error
- `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)