customObjectLookupOptions

The selectable values for a lookup target.

With no other argument this returns every candidate the target has, whatever its size, so a picker can offer the whole list without making the user type first. A target that no longer resolves returns an empty list. Pass search and/or first to page through any target instead. Pass ids to label values you already hold.

customObjectLookupOptions(
  lookup_object_id: Int!
  search: String
  first: Int
  ids: [ID!]
): [CustomObjectLookupOption!]!

Arguments

customObjectLookupOptions.lookup_object_id ● Int! non-null scalar

customObjectLookupOptions.search ● String scalar

Matches the text shown in the picker. An empty value returns the first page.

customObjectLookupOptions.first ● Int scalar

How many to return when searching. Defaults to 50, capped at 100.

customObjectLookupOptions.ids ● [ID!] list scalar

Return exactly these records, ignoring search and first. Resolves deleted records too.

Type

CustomObjectLookupOption object

A selectable value for a LOOKUP field: the id stored as the field's value, and the label to show for it. The whole list is returned in one call — there is no search or paging.