List

List

client.Apps.Connectors.List(ctx, appID, query) (*ExpandedarrayListarrayNextPageTokenstringAppConnectorListResponse, error)

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

List connectors for an app.

Parameters

appIDstring

The appId field.

queryPageSizefieldPageTokenfieldAppConnectorListParams

Hide ParametersShow Parameters

PageSizefield

optional

param.Field[int64]

The pageSize field.

formatint32

PageTokenfield

optional

param.Field[string]

The pageToken field.

Returns

AppConnectorListResponsestruct

The ConnectorServiceListResponse message contains a list of results and a nextPageToken if applicable

Hide ParametersShow Parameters

Expandedarray

optional

[]AppConnectorListResponseExpanded

List of serialized related objects

Hide ParametersShow Parameters

Typestring

optional

The type of the serialized message.

Listarray

optional

[]AppPathstringConnectorC1APIAppV1ConnectorUsersPathstringC1APIAppV1ConnectorView

The list of results containing up to X results, where X is the page size defined in the request

Hide ParametersShow Parameters

AppPathstring

optional

JSONPATH expression indicating the location of the App object in the expanded array.

ConnectorIDstringAppIDstringCatalogIDstringConfigC1APIAppV1ConnectorConfigCreatedAtTimeDeletedAtTimeDescriptionstringDisplayNamestringDownloadURLstringOAuthAuthorizedAsC1APIAppV1OAuth2AuthorizedAsProfileAllowListarrayProfileIgnoreListarrayStatusC1APIAppV1ConnectorStatusSyncDisabledAtTimeSyncDisabledCategorystringSyncDisabledReasonstringUpdatedAtTimeUserIDsarrayC1APIAppV1Connector

optional

A Connector is used to sync objects into Apps

UsersPathstring

optional

JSONPATH expression indicating the location of the User object in the expanded array. This is the user that is a direct target of the ticket without a specific relationship to a potentially non-existent app user.

NextPageTokenstring

optional

The nextPageToken is shown for the next page if the number of results is larger than the max page size. The server returns one page of results and the nextPageToken until all results are retreived. To retrieve the next page, use the same request and append a pageToken field with the value of nextPageToken shown on the previous page.

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"),
  )
  connectors, err := client.Apps.Connectors.List(
    context.TODO(),
    "app_id",
    conductoronesdk.AppConnectorListParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", connectors.Expanded)
}

200 Example

{
  "expanded": [
    {
      "@type": "@type"
    }
  ],
  "list": [
    {
      "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"
    }
  ],
  "nextPageToken": "nextPageToken"
}