List Connection Fields

See what connecting an app takes: each sign-in method, the app's default first, and the fields its form asks for. A method with requiresBrowser false is created with Create Connection; one with requiresBrowser true (OAuth) needs a person to sign in through Create Connect Link.

GET

Headers

Optional headers

string

Optional. The id of the organization to act in. Leave it out to act in the API key's own organization. A key can also act in its child organizations, and, with "Use this key across all of your organizations" on, in every organization its creator can open in the app. List them with GET /v2/companies. Every response's X-Company-Id header names the organization it acted in. See Organizations.

Query

Arguments

stringrequired

Required. An app id or slug, from List Universal Apps.

Required. The app, by its id or slug, from List Universal Apps.

FiltersNarrow list results with a provider-supported where expression. Learn more

string

RSQL expression used to filter list results.

PaginationRequest a specific window of rows with limit and offset. Learn more

number

Maximum number of rows to return.

number

Number of rows to skip.

SortingChoose the order of returned rows when this action supports sorting. Learn more

string

Comma-separated sort fields; prefix with - for descending.

Field selectionChoose which fields should be included in the response. Learn more

string

Comma-separated response fields to include.

Response fields

idstring

The sign-in method id: authenticationId in Create Connection and Create Connect Link.

typestring

How it signs in: oAuth2, oAuth1, apiKey, basic, custom, ftp or none.

namestring

The method's name, as the app's connection form shows it.

requiresBrowserboolean

True when a person signs in at the provider in a browser (OAuth): use Create Connect Link. False when the fields are typed in: use Create Connection.

fieldsarray of objects

What the connection form asks for, in its order. Send their values by key in credentials. Empty for a method that asks for nothing typed in.

keystring
The key to send the value under in credentials.
labelstring
The label the form shows.
typestring
The kind of value.
- stringText.
- booleantrue or false.
- numberA number.
- dateA date, as ISO 8601 text.
- listOne of options, or an array of them.
requiredboolean
True when a new connection needs it.
isSecretboolean
True for a secret (an API key, a password, a token): the form hides it, and no MindCloud response ever answers it.
descriptionstring
The app's help text for it.
optionsarray
The values it accepts, when it is a choice.
- valuestring
  The value to send.
- labelstring
  What the form shows for it.