Skip to content
Console(opens in a new tab)

ListSearchInputInput

The search settings of a list, for `createList` and `updateList`.

Match. This input describes the records that you want to find. You pass it to CreateListInput.searchInput and UpdateListInput.searchInput.

The search settings of a list, for createList and updateList. The API stores these settings together with the search selection of the mutation.

Field Type Part Description
entityType EntityType Subject The type of entity that each record of the list represents. The createList mutation does not support PERSON. One of BRAND, OPERATING_LOCATION, LEGAL_ENTITY, PERSON, ADDRESS.
conditions ListConditionsInput Condition The filter, sort, and limit settings of the search.
prompt String Match A plain-language description of the businesses that the list includes.
matchThreshold Float Match The minimum match confidence, from 0 to 1, that an input row must reach. Only an ENRICHMENT list accepts this field.

This intent writes, so the reference does not run it against production data. No response is shown.

mutation {
createList(input: {
name: "Texas grocery brands"
listType: LIST_GENERATION
searchInput: {
entityType: BRAND
prompt: "Grocery store brands in Texas"
}
}) {
list { id name createdTimestamp }
search {
... on Brand {
id
names(first: 1) { edges { node { name } } }
}
}
}
}