Retrieve

Get

client.Apps.Connectors.Get(ctx, id, query) (*ConnectorViewC1APIAppV1ConnectorViewExpandedarrayAppConnectorGetResponse, error)

get/api/v1/apps/{app_id}/connectors/{id}

Get a connector.

Parameters

idstring

The id of the connector.

queryAppIDfieldAppConnectorGetParams

Hide ParametersShow Parameters

AppIDfield

param.Field[string]

The appId of the app the connector is attached to.

Returns

AppConnectorGetResponsestruct

The ConnectorServiceGetResponse message contains the connectorView, and an expand mask.

Hide ParametersShow Parameters

ConnectorViewAppPathstringConnectorC1APIAppV1ConnectorUsersPathstringC1APIAppV1ConnectorView

optional

The ConnectorView object provides a connector response object, as well as JSONPATHs to related objects provided by expanders.

Expandedarray

optional

[]AppConnectorGetResponseExpanded

The array of expanded items indicated by the request.

Hide ParametersShow Parameters

Typestring

optional

The type of the serialized message.

Request example Go

package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/-go"
  "github.com/stainless-sdks/-go/option"
)

func main() {
  client := conductoronesdk.NewClient(
    option.WithAPIKey("My API Key"),
  )
  connector, err := client.Apps.Connectors.Get(
    context.TODO(),
    "id",
    conductoronesdk.AppConnectorGetParams{
      AppID: "app_id",
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", connector.ConnectorView)
}

200 Example

{
  "connectorView": {
    "appPath": "appPath",
    "connector": {
      "id": "id",
      "appId": "appId",
      "catalogId": "catalogId",
      "config": {
        "@type": "@type"
      },
      "description": "description",
      "displayName": "displayName",
      "oauthAuthorizedAs": {},
      "profileAllowList": [
        "string"
      ],
      "profileIgnoreList": [
        "string"
      ],
      "status": {
        "completedAt": "2019-12-27T18:11:19.117Z",
        "lastError": "lastError",
        "startedAt": "2019-12-27T18:11:19.117Z",
        "status": "SYNC_STATUS_UNSPECIFIED",
        "updatedAt": "2019-12-27T18:11:19.117Z"
      },
      "syncDisabledCategory": "syncDisabledCategory",
      "syncDisabledReason": "syncDisabledReason",
      "userIds": [
        "string"
      ]
    },
    "usersPath": "usersPath"
  },
  "expanded": [
    {
      "@type": "@type"
    }
  ]
}