Resolve Universal Lookup

Resolve choices for one action argument, such as finding Slack channels before sending a message. Needs the universal:read permission. limit accepts 1 to 200 and defaults to 50. Parent delegation cannot use Embedded connections, including by connectionId alone.

GET

Path

Path parameters

stringrequired

The app slug from List Universal Apps.

stringrequired

The action slug from List Universal Actions.

stringrequired

The argument key whose choices you need.

Headers

Optional headers

string

Optional. The id of a child organization of your API key's company to act on. Leave it out to act on the key's own company. See Child organizations.

Query

Arguments

string

The published app version. Defaults to latest.

The app version to inspect. Defaults to latest.

Default: latest

string

Search the lookup choices.

Search text to resolve, for example a channel, user, customer, or project name.

string

An exact public connection ID. With endUserId, select one account when several are usable.

The public MindCloud connection ID to use when the lookup source requires authentication.

string

Use only accounts owned by this embedded end user. The API key company must own the end user.

Use only connections owned by this embedded end user. The API key company must own the end user.

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.

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

string

Comma-separated response fields to include.

Response fields

statusstring

Whether the lookup resolved or needs more input: resolved, ambiguous, or notFound.

resolved
ambiguous
notFound

reasonCodestring

A stable reason code: EXACT_MATCH, STRONG_MATCH, MULTIPLE_HIGH_CONFIDENCE_CANDIDATES, INSUFFICIENT_CONFIDENCE, or NO_CANDIDATES.

selectedobject

The selected lookup option, when one exact match exists.

valuestring
The canonical value to pass as the argument.
labelstring
What the option is called.

candidatesarray of objects

Matching options the caller can choose from.

valuestring
The canonical value to pass as the argument.
labelstring
What the option is called.

sourcestring

Where the choices came from: fixedOptions (the argument's own list) or lookupAction (a provider read).

fixedOptions
lookupAction

lookupobject

The lookup definition for this argument.

labelKeystring
The source field shown as the option label.
valueKeystring
The source field passed as the argument value.
actionIdstring
The action that lists the options, or null for fixed options.

pagingobject

Offset paging details for the candidates.

limitnumber
The limit the source was asked for.
offsetnumber
The offset the source was asked for.
fetchedCandidatesCountnumber
How many options the source answered.

hintsarray of objects

Instructions for the caller when more input is needed.

codestring
NO_CANDIDATES, or the reasonCode that needs a choice.
messagestring
What to do next.