Skip to main content

Get all/Search lookup lists

POST 
/v1/lookup-lists/search

Searches for lookup lists by name or ID. Can also be run without a filter to return the full list of existing lookups. Returns a paginated list of results.

Request​

Body

    filter object

    Filter by names that contain a term, by lookup ID, or by both. If both properties are sent, they must both be satsified (AND logic).

    searchTerm string

    Filters for lookup names that contains the search term.

    byIds string[]

    List of lookup IDs.

    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.

      results object[]
    • Array [
      • id string

      GUID of the lookup list.

      name string

      Possible values: non-empty and <= 40 characters

      Name of the lookup list.

      description string

      Possible values: <= 400 characters

      Description of the lookup list.

    • ]
      • 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...