v1

latestOpenAPI 3.0.12026-07-2427125325.2 KB

/essentials/lookup/{filter_name}

Provides a list of all the human-readable search values within a specific filter_name table, which can then be used in search queries with the Essentials endpoints. Each array contains a table key, name value, and search value. The resulting search_value(s) can be passed as search values in the Essentials API.

get/lookup/{filter_name}

Path parameters

filter_namestring required

Response

codeinteger

HTTP response status code.

messagestring

tookinteger

errorsstring[]

Example response

{
  "code": 200,
  "message": "Request was processed successfully!",
  "took": 20,
  "errors": [],
  "data": [
    {
      "key": "A00",
      "value": "Arts, Culture, and Humanities",
      "search_value": "A_artsCulturesAndHumanities"
    }
  ]
}