---
title: "SearchPayload"
url: "https://nov18-dev.movespot.fyi/apis/konnect-search-dev-1/versions/43a10fd2-5298-43cc-abd4-e0bd4176a167/schemas/SearchPayload"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-search-dev-1/versions/43a10fd2-5298-43cc-abd4-e0bd4176a167.md

# SearchPayload

Search request payload Use **`query`** when you want to search for targeted, full-text or filtered search using Lucene-like syntax. This is ideal for searching across multiple fields, applying logical operators, or when you need advanced filtering capabilities. example: type:consumer AND name:us-control-west2 AND @scope:realm Use **`bulk_lookup`** when you need to retrieve more entities by a specific set of attribute values, such as a list of IDs or other unique keys. example: Retrieve details for a list of known user IDs or system accounts. Only one of `query` or `bulk_lookup` should be provided per request.

## OpenAPI definition

```yaml
openapi: 3.0.2
info:
  title: Konnect Search
  version: 1.0.0
servers:
  - url: https://us.api.konghq.com/v1
    description: United-States Production region
  - url: https://eu.api.konghq.com/v1
    description: Europe Production region
  - url: https://au.api.konghq.com/v1
    description: Australia Production region
  - url: https://me.api.konghq.com/v1
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v1
    description: India Production region
  - url: https://sg.api.konghq.com/v1
    description: Singapore Production region
  - url: https://global.api.konghq.com/v1
    description: Global Production
components:
  schemas:
    SearchPayloadQueryRequest:
      type: object
      properties:
        query:
          description: >
            The query that defines the search criteria. Supports Lucene-like
            syntax for filtering results. Learn more about search query syntax
            [here](https://docs.konghq.com/konnect/reference/search).
          type: string
          example: type:consumer AND @scope:realm AND id:(abc OR xyz OR 123)
      required:
        - query
    SearchPayloadBulkLookupRequest:
      type: object
      properties:
        bulk_lookup:
          $ref: "#/components/schemas/SearchPayloadBulkLookup"
      required:
        - bulk_lookup
    SearchPayloadBulkLookup:
      description: Bulk lookup of entities matching the values.
      type: object
      properties:
        type:
          description: The entity type.
          type: string
        filters:
          description: The values to lookup.
          type: array
          items:
            type: object
            additionalProperties:
              type: string
          maxItems: 1000
          minItems: 1
      required:
        - type
        - filters
      title: SearchPayloadBulkLookup
    SearchPayload:
      description: >
        Search request payload

        Use **`query`** when you want to search for targeted, full-text or
        filtered search using Lucene-like syntax. This is ideal for searching
        across multiple fields, applying logical operators, or when you need
        advanced filtering capabilities.  

        example: type:consumer AND name:us-control-west2 AND @scope:realm


        Use **`bulk_lookup`** when you need to retrieve more entities by a
        specific set of attribute values, such as a list of IDs or other unique
        keys.  

        example: Retrieve details for a list of known user IDs or system
        accounts.


        Only one of `query` or `bulk_lookup` should be provided per request.
      oneOf:
        - $ref: "#/components/schemas/SearchPayloadQueryRequest"
        - $ref: "#/components/schemas/SearchPayloadBulkLookupRequest"
      title: SearchPayload
```
