Skip to main content

Get all/Search lookup elements

POST 
/v1/lookup-lists/:lookupListId/elements/search

Searches elements in a specified lookup list. Can also be run without a filter to return the full list of elements. Returns a paginated list of results.

Request​

Path Parameters

    lookupListId stringrequired

    GUID of the lookup list.

    Example: 7c985e09-3db6-5dc6-ae33-58403493e13f

Body

    filter object

    Filter for elements by value, element ID, or by comments that contain a search term. If multiple properties are sent, they must all be satisfied (AND logic).

    searchTerm string

    Filters for values or comments that contain the search term.

    byIds int32[]

    Filters by element IDs.

    byValues string[]

    Filters by exact value. (Looks for elements that match any one of the values in the array.)

    pagination object

    Default pagination is a page of 25 results. Look for the total field in the response for the number of available results overall, and use the pagination function to page through the results.

    pageNumber int32

    Default value: 1

    If you overshoot the page number, it will return empty with no results, but it won't fail the request.

    pageSize int32

    Possible values: <= 1000

    Default value: 25

    Controls the number of results per page. Valid inputs are 1 to 1000.

Responses​

successful operation

Response Headers
    Schema
      total int32

      Total number of search results. The results are relvent elements contained in the lookup list.

      results object[]
    • Array [
      • id int32

      ID of the element in the Lookup list.

      value string

      Possible values: non-empty and <= 80 characters

      A single field value. You should ensure that the lookup list contains a list of values all mapped to the same field.

      comment string

      Possible values: <= 200 characters

      Optional. A place to add a note or additional details about the value. For example, if the value is an IP address, the comment can identify the server.

      expirationDate int64

      Optional. The expiration date and time of the lookup list as UNIX epoch milliseconds. When this parameter is left empty, the lookup list does not expire.

    • ]
      • pagination object

      Default pagination is a page of 25 results. Look for the total field in the response for the number of available results overall, and use the pagination function to page through the results.

      pageNumber int32

      Default value: 1

      If you overshoot the page number, it will return empty with no results, but it won't fail the request.

      pageSize int32

      Possible values: <= 1000

      Default value: 25

      Controls the number of results per page. Valid inputs are 1 to 1000.

    Loading...