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

# Workspace connections

> Read connection summaries without provider credentials

CLI: `adside workspace connections`



## OpenAPI

````yaml /api-reference/openapi.yaml get /v1/workspaces/{workspaceId}/connections
openapi: 3.1.0
info:
  title: Adside API
  version: 1.0.0
  description: >-
    Campaigns, creatives, assets and reporting across your ad accounts. Call it
    with a personal API key as a bearer token, or with the `adside` CLI: each
    page names its command.
servers:
  - url: https://api.adside.ai
    description: Production
security:
  - userAccess: []
tags:
  - name: Account
  - name: Reporting
  - name: Meta
  - name: Google Ads
  - name: LinkedIn
  - name: TikTok
  - name: Reddit
  - name: Snapchat
  - name: X
  - name: Google Tag Manager
  - name: Creatives
  - name: Creative styles
  - name: Media
  - name: Characters
  - name: Assets
  - name: Brands
  - name: Brain
  - name: Research
  - name: Boards
  - name: Artifacts
  - name: Audiences
  - name: Ad comments
  - name: Publications
  - name: Routines
  - name: Skills
  - name: To-dos
  - name: Audit
  - name: Credits
paths:
  /v1/workspaces/{workspaceId}/connections:
    get:
      tags:
        - Reporting
      summary: Workspace connections
      description: |-
        Read connection summaries without provider credentials

        CLI: `adside workspace connections`
      operationId: workspace.connections
      parameters:
        - name: workspaceId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
        - name: includeSync
          in: query
          required: false
          schema:
            default: 'false'
            type: string
            enum:
              - 'false'
              - 'true'
          style: form
          explode: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  connections:
                    type: array
                    items:
                      type: object
                      properties:
                        channel:
                          type: string
                          enum:
                            - META
                            - GOOGLE_ADS
                            - GOOGLE_DRIVE
                            - GOOGLE_TAG_MANAGER
                            - GOOGLE_ANALYTICS
                            - POSTHOG
                            - TIKTOK
                            - LINKEDIN
                            - SNAPCHAT
                            - REDDIT
                            - X
                            - CANVA
                            - FIGMA
                            - GITHUB
                        status:
                          type: string
                          enum:
                            - PENDING
                            - CONNECTED
                            - EXPIRED
                            - ERROR
                            - PROVISIONING
                            - DISCONNECTING
                        tokenType:
                          type: string
                          enum:
                            - OAUTH_LONG_LIVED
                            - SYSTEM_USER
                        tokenStatus:
                          type: string
                          enum:
                            - valid
                            - expiring_soon
                            - expired
                        tokenExpiresAt:
                          anyOf:
                            - type: string
                            - type: 'null'
                        connectedAt:
                          anyOf:
                            - type: string
                            - type: 'null'
                        errorMessage:
                          anyOf:
                            - type: string
                            - type: 'null'
                        metadata:
                          anyOf:
                            - {}
                            - type: 'null'
                        currency:
                          default: null
                          anyOf:
                            - type: string
                            - type: 'null'
                        missingScopeFeatures:
                          default: []
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                              label:
                                type: string
                            required:
                              - id
                              - label
                            additionalProperties: false
                      required:
                        - channel
                        - status
                        - tokenType
                        - tokenStatus
                        - tokenExpiresAt
                        - connectedAt
                        - errorMessage
                        - metadata
                        - currency
                        - missingScopeFeatures
                      additionalProperties: false
                  slack:
                    type: object
                    properties:
                      installation:
                        anyOf:
                          - type: object
                            properties:
                              teamName:
                                type: string
                              status:
                                type: string
                                enum:
                                  - CONNECTED
                                  - ERROR
                              errorMessage:
                                anyOf:
                                  - type: string
                                  - type: 'null'
                            required:
                              - teamName
                              - status
                              - errorMessage
                            additionalProperties: false
                          - type: 'null'
                      destinations:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                            channelId:
                              type: string
                            channelName:
                              type: string
                            isPrivate:
                              type: boolean
                            isDefault:
                              type: boolean
                          required:
                            - id
                            - channelId
                            - channelName
                            - isPrivate
                            - isDefault
                          additionalProperties: false
                    required:
                      - installation
                      - destinations
                    additionalProperties: false
                  syncStatuses:
                    type: object
                    propertyNames:
                      type: string
                    additionalProperties:
                      type: object
                      properties:
                        status:
                          type: string
                          enum:
                            - never_synced
                            - syncing
                            - completed
                            - failed
                            - token_expired
                        lastSyncStartedAt:
                          anyOf:
                            - type: string
                              format: date-time
                              pattern: >-
                                ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                            - type: 'null'
                        lastSyncCompletedAt:
                          anyOf:
                            - type: string
                              format: date-time
                              pattern: >-
                                ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                            - type: 'null'
                        recordsCommitted:
                          anyOf:
                            - type: integer
                              minimum: -9007199254740991
                              maximum: 9007199254740991
                            - type: 'null'
                        errorMessage:
                          anyOf:
                            - type: string
                            - type: 'null'
                        isFirstSync:
                          type: boolean
                      required:
                        - status
                        - lastSyncStartedAt
                        - lastSyncCompletedAt
                        - recordsCommitted
                        - errorMessage
                        - isFirstSync
                      additionalProperties: false
                required:
                  - connections
                  - slack
                additionalProperties: false
      security:
        - userAccess: []
components:
  securitySchemes:
    userAccess:
      type: http
      scheme: bearer
      description: >-
        A personal API key (`adside_pat_…`) or a token from `adside login`.
        Either carries the permissions of the person it belongs to.

````

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