> ## Documentation Index
> Fetch the complete documentation index at: https://api.onlysocial.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a connection

> The authoritative result of a session. Read it when your customer comes back to your return URL.



## OpenAPI

````yaml /api-reference/partner.openapi.json get /partner/workspaces/{workspace}/channel-connections/{connection}
openapi: 3.1.0
info:
  title: Partner API
  version: 1.0.0
  description: >-
    Provision your customers, sign them in with single sign-on, issue their
    workspace API keys and connect their messaging channels. Authenticated by
    your partner key as `X-API-KEY`, from your backend only.
servers:
  - url: https://app.onlysocial.io/api
    description: OnlySocial
security:
  - partnerKey: []
tags:
  - name: Customers
    description: Create or refresh a customer's account and workspace.
  - name: Single sign-on
    description: Swap a token signed with your SSO secret for a one-time sign-in link.
  - name: Workspace API keys
    description: Issue, list and revoke the `osk_` keys of a workspace you provisioned.
  - name: Channel Connect
    description: Hosted links that connect a customer's own messaging channels.
paths:
  /partner/workspaces/{workspace}/channel-connections/{connection}:
    parameters:
      - $ref: '#/components/parameters/Workspace'
      - $ref: '#/components/parameters/Connection'
    get:
      tags:
        - Channel Connect
      summary: Get a connection
      description: >-
        The authoritative result of a session. Read it when your customer comes
        back to your return URL.
      responses:
        '200':
          description: The connection
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionEnvelope'
        '401':
          $ref: '#/components/responses/Unauthenticated'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    Workspace:
      name: workspace
      in: path
      required: true
      description: >-
        A workspace uuid from provisioning. It must be administered by a
        customer you provisioned.
      schema:
        type: string
        format: uuid
    Connection:
      name: connection
      in: path
      required: true
      description: The connection `id`.
      schema:
        type: string
        format: uuid
  schemas:
    ConnectionEnvelope:
      type: object
      properties:
        success:
          type: boolean
          example: true
        data:
          $ref: '#/components/schemas/Connection'
    Connection:
      type: object
      properties:
        id:
          type: string
          format: uuid
        workspace_id:
          type: string
          format: uuid
        platform:
          type: string
          enum:
            - whatsapp
            - facebook
            - instagram
            - tiktok
        coexistence:
          type: boolean
        status:
          type: string
          enum:
            - pending
            - authorizing
            - selecting
            - connected
            - failed
            - cancelled
            - expired
        channel_id:
          type:
            - string
            - 'null'
          format: uuid
          description: The channel, once `connected`.
        error_code:
          type:
            - string
            - 'null'
          description: >-
            Why it `failed`. See [Error
            codes](/partner/channel-connect#error-codes).
        state:
          type:
            - string
            - 'null'
        expires_at:
          type: string
          format: date-time
        connect_url:
          type: string
          format: uri
          description: >-
            Only on a pending, unexpired session. A one-session capability: hand
            it straight to the customer's browser and never log it.
    Error:
      type: object
      properties:
        success:
          type: boolean
          example: false
        message:
          type: string
        error_code:
          type: string
  responses:
    Unauthenticated:
      description: Missing or invalid partner key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            success: false
            message: Invalid or inactive API key.
    NotFound:
      description: >-
        Not found, or not yours. Another partner's workspace and a uuid that
        does not exist look the same.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    partnerKey:
      type: apiKey
      in: header
      name: X-API-KEY
      description: Your partner API key, `pk_…`. Backend only.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.