---
title: "Search Konnect"
url: "https://nov18-dev.movespot.fyi/apis/konnect-search-dev-1/versions/43a10fd2-5298-43cc-abd4-e0bd4176a167/operations/post-search"
---

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

# Search Konnect

`POST` `/search`

Operation ID: `post-search`

Retrieves a list of Konnect entities matching the search query provided.

## Query parameters

- `page[size]` (integer, optional) - The maximum number of items to include per page. The last page of a collection may include fewer items.
- `page[after]` (string, optional) - Request the next page of data, starting with the item after this parameter.

## Request body (required)

Content types: `application/json`

## Responses

- `200` - Search response for containing all matched Konnect entities.
- `400` - Bad Request
- `401` - Unauthorized
- `403` - Forbidden
- `404` - Not Found

## 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
paths:
  /search:
    post:
      operationId: post-search
      summary: Search Konnect
      description: Retrieves a list of Konnect entities matching the search query provided.
      parameters:
        - $ref: "#/components/parameters/PageSize"
        - $ref: "#/components/parameters/PageAfter"
      requestBody:
        $ref: "#/components/requestBodies/SearchRequest"
      responses:
        "200":
          $ref: "#/components/responses/PostSearchResponse"
        "400":
          $ref: "#/components/responses/SearchBadRequest"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
        "404":
          $ref: "#/components/responses/NotFound"
      externalDocs:
        description: Learn more about search query syntax.
        url: https://docs.konghq.com/konnect/reference/search
      tags:
        - Search
security:
  - personalAccessToken: []
  - systemAccountAccessToken: []
  - konnectAccessToken: []
components:
  parameters:
    PageSize:
      name: page[size]
      description: The maximum number of items to include per page. The last page of a
        collection may include fewer items.
      required: false
      in: query
      allowEmptyValue: true
      schema:
        type: integer
        example: 10
    PageAfter:
      name: page[after]
      description: Request the next page of data, starting with the item after this
        parameter.
      required: false
      in: query
      allowEmptyValue: true
      schema:
        type: string
        example: ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ
  requestBodies:
    SearchRequest:
      description: Search request payload
      required: true
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/SearchPayload"
          examples:
            Search Request Example Query:
              $ref: "#/components/examples/SearchRequestExample"
            Search Request Example Bulk Lookup:
              $ref: "#/components/examples/SearchRequestExample2"
  responses:
    PostSearchResponse:
      description: Search response for containing all matched Konnect entities.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/SearchResponse"
          examples:
            Successful Search Response:
              $ref: "#/components/examples/PostSearchResponseSuccess"
    SearchBadRequest:
      description: Bad Request
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/BadRequestError"
          examples:
            Request Format is Invalid:
              $ref: "#/components/examples/400-query-is-invalid"
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/UnauthorizedExample"
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/ForbiddenExample"
    NotFound:
      description: Not Found
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/NotFoundError"
          examples:
            NotFoundExample:
              $ref: "#/components/examples/NotFoundExample"
  schemas:
    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
    SearchResponse:
      description: Search response schema.
      type: object
      properties:
        data:
          type: array
          items:
            $ref: "#/components/schemas/SearchResultItem"
        meta:
          $ref: "#/components/schemas/SearchCursorMeta"
      title: SearchResponse
    BadRequestError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          required:
            - invalid_parameters
          properties:
            invalid_parameters:
              $ref: "#/components/schemas/InvalidParameters"
    UnauthorizedError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 401
            title:
              example: Unauthorized
            type:
              example: https://httpstatuses.com/401
            instance:
              example: kong:trace:1234567890
            detail:
              example: Invalid credentials
    ForbiddenError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 403
            title:
              example: Forbidden
            type:
              example: https://httpstatuses.com/403
            instance:
              example: kong:trace:1234567890
            detail:
              example: Forbidden
    NotFoundError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 404
            title:
              example: Not Found
            type:
              example: https://httpstatuses.com/404
            instance:
              example: kong:trace:1234567890
            detail:
              example: Not found
    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
    SearchResultItem:
      description: Item included in the list of search results.
      type: object
      properties:
        id:
          description: Unique identifier for the record.
          type: string
        type:
          description: Konnect entity type.
          type: string
        name:
          description: Name of the entity.
          type: string
        description:
          description: Description of the entity.
          type: string
        labels:
          description: Labels for the entity.
          type: object
        relations:
          description: Relations for the entity.
          type: object
        attributes:
          description: Attributes for the entity.
          type: object
        match:
          description: The matched text from the record.
          type: string
        relations_list:
          description: The relations tree with child and sibling relations.
          type: array
          items:
            $ref: "#/components/schemas/Relation"
          nullable: true
      required:
        - id
        - type
        - name
      title: SearchResultItem
    SearchCursorMeta:
      description: Pagination metadata.
      type: object
      properties:
        page:
          $ref: "#/components/schemas/SearchCursorMetaPage"
      required:
        - page
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          type: integer
          readOnly: true
        title:
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
        type:
          description: The error type.
          type: string
          readOnly: true
        instance:
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
    InvalidParameters:
      description: invalid parameters
      type: array
      items:
        oneOf:
          - $ref: "#/components/schemas/InvalidParameterStandard"
          - $ref: "#/components/schemas/InvalidParameterMinimumLength"
          - $ref: "#/components/schemas/InvalidParameterMaximumLength"
          - $ref: "#/components/schemas/InvalidParameterChoiceItem"
          - $ref: "#/components/schemas/InvalidParameterDependentItem"
      minItems: 1
      nullable: false
      uniqueItems: true
    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
    Relation:
      type: object
      properties:
        type:
          description: The type of the related entity.
          type: string
        id:
          description: The unique identifier of the related entity.
          type: string
        child_relations:
          description: The child relations of the related entity.
          type: array
          items:
            $ref: "#/components/schemas/Relation"
          nullable: true
      required:
        - type
        - id
        - child_relations
    SearchCursorMetaPage:
      type: object
      properties:
        next:
          description: URI to the next page
          type: string
          format: path
          nullable: true
        size:
          description: Requested page size
          type: number
          example: 10
      required:
        - size
    InvalidParameterStandard:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          $ref: "#/components/schemas/InvalidRules"
        source:
          type: string
          example: body
        reason:
          type: string
          example: is a required field
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
    InvalidParameterMinimumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - min_length
            - min_digits
            - min_lowercase
            - min_uppercase
            - min_symbols
            - min_items
            - min
          nullable: false
          readOnly: true
        minimum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must have at least 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - minimum
    InvalidParameterMaximumLength:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - max_length
            - max_items
            - max
          nullable: false
          readOnly: true
        maximum:
          type: integer
          example: 8
        source:
          type: string
          example: body
        reason:
          type: string
          example: must not have more than 8 characters
          readOnly: true
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - maximum
    InvalidParameterChoiceItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - enum
          nullable: false
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        choices:
          type: array
          items: {}
          minItems: 1
          nullable: false
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - reason
        - rule
        - choices
    InvalidParameterDependentItem:
      type: object
      properties:
        field:
          type: string
          example: name
          readOnly: true
        rule:
          description: invalid parameters rules
          type: string
          enum:
            - dependent_fields
          nullable: true
          readOnly: true
        reason:
          type: string
          example: is a required field
          readOnly: true
        dependents:
          type: array
          items: {}
          nullable: true
          readOnly: true
          uniqueItems: true
        source:
          type: string
          example: body
      additionalProperties: false
      required:
        - field
        - rule
        - reason
        - dependents
    InvalidRules:
      description: invalid parameters rules
      type: string
      enum:
        - required
        - is_array
        - is_base64
        - is_boolean
        - is_date_time
        - is_integer
        - is_null
        - is_number
        - is_object
        - is_string
        - is_uuid
        - is_fqdn
        - is_arn
        - unknown_property
        - missing_reference
        - is_label
        - matches_regex
        - invalid
        - is_supported_network_availability_zone_list
        - is_supported_network_cidr_block
        - is_supported_provider_region
        - type
      nullable: true
      readOnly: true
  examples:
    SearchRequestExample:
      value:
        query: type:consumer AND @scope:realm AND id:(abc OR xyz OR 123)
    SearchRequestExample2:
      value:
        bulk_lookup:
          type: consumer
          filters:
            - id: id-1
              relations.control_plane_id: 060e479c-166c-4921-a22c-49a24bbb2c63
            - id: id-2
              name: name-2
              relations.control_plane_id: 060e479c-166c-4921-a22c-49a24bbb2c64
            - id: id-3
              attributes.custom_id: custom-id-3
              attributes.realm_id: realm-123
    PostSearchResponseSuccess:
      value:
        data:
          - id: c0010105-e840-4824-b7ee-787f22267c36
            type: consumer
            name: example-consumer-1
            description: example consumer 1
            labels:
              env: prod
            attributes:
              username: example-consumer-1
              custom_id: example-consumer-1
              created_at: 2022-07-31T09:15:15.04Z
              updated_at: 2023-02-11T18:47:03.34Z
            relations:
              control_plane_id: 060e479c-166c-4921-a22c-49a24bbb2c63
          - id: c0010105-e840-4824-b7ee-787f22267c37
            type: consumer
            name: example-consumer-2
            description: example consumer 2
            attributes:
              username: example-consumer-2
              custom_id: example-consumer-2
              created_at: 2022-07-31T09:15:15.04Z
              updated_at: 2023-02-11T18:47:03.34Z
            relations:
              control_plane_id: 060e479c-166c-4921-a22c-49a24bbb2c64
          - id: c0010105-e840-4824-b7ee-787f22267c38
            type: consumer
            name: example-consumer-3
            description: example consumer 3
            attributes:
              username: example-consumer-3
              custom_id: example-consumer-3
              created_at: 2022-07-31T09:15:15.04Z
              updated_at: 2023-02-11T18:47:03.34Z
            relations:
              control_plane_id: 060e479c-166c-4921-a22c-49a24bbb2c65
        meta:
          page:
            size: 3
            next: /search?q=son&page[after]=ewogICJpZCI6ICJoZWysbyB3b3JsZCIKgZ
    400-query-is-invalid:
      value:
        status: 400
        title: Bad Request
        detail: Invalid query.
        instance: konnect:trace:3674017986744198214
        invalid_parameters:
          - field: q
            reason: invalid query
            source: query
    UnauthorizedExample:
      value:
        status: 401
        title: Unauthorized
        instance: kong:trace:8347343766220159418
        detail: Unauthorized
    ForbiddenExample:
      value:
        status: 403
        title: Forbidden
        instance: kong:trace:2723154947768991354
        detail: You do not have permission to perform this action
    NotFoundExample:
      value:
        status: 404
        title: Not Found
        instance: kong:trace:6816496025408232265
        detail: Not Found
  securitySchemes:
    personalAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The personal access token is meant to be used as an alternative to
        basic-auth when accessing Konnect via APIs.

        You can generate a Personal Access Token (PAT) from the [personal access
        token page](https://cloud.konghq.com/global/account/tokens/) in the
        Konnect dashboard.

        The PAT token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer kpat_xgfT...'`
    systemAccountAccessToken:
      type: http
      scheme: bearer
      bearerFormat: Token
      description: >
        The system account access token is meant for automations and
        integrations that are not directly associated with a human identity.

        You can generate a system account Access Token by creating a system
        account and then obtaining a system account access token for that
        account.

        The access token must be passed in the header of a request, for example:

        `curl -X GET 'https://global.api.konghq.com/v2/users/' --header
        'Authorization: Bearer spat_i2Ej...'`
    konnectAccessToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        The Konnect access token is meant to be used by the Konnect dashboard
        and the decK CLI authenticate with.
```
