Looks up the options for a Spark template input

Looks up the valid answers for one selection input of a Spark template task. Use it for inputs whose
lookup is set (answers from a connected platform), and for fixed-list inputs (options).
Send the option you pick back in tasks[].inputs as { "value": ..., "displayLabel": ... }.

Required scope: spark-templates

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

This endpoint returns valid options for one selection input in a Spark template task.
Use this endpoint for an input with lookup or options in GET /v1/spark-templates.

Prepare the request:

  • If lookup.searchable is true, send search with 3 or more characters.
  • If lookup.dependsOn has keys, send parent[key]=value for each key. Use the value of the option selected for that input.

For lookup inputs, send the selected option back in tasks[].inputs exactly as this endpoint returns it.
For fixed-list inputs, send only the option's value.

The options come from the connected platform, such as SmartMoving.
If the platform rejects the request, the API returns 422 with the platform's error text.

Path Params
uuid
required

The Spark template id from GET /v1/spark-templates.

string
required

The task's codeName.

string
required

The input's key.

Query Params

What to search for, when the input's lookup.searchable is true (e.g. a name, phone number or email). For a fixed list it filters by label.

parent
object

Values of the inputs listed in lookup.dependsOn, as parent[key]=value — the value you picked for each.

Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json