---
title: "List Search Types"
url: "https://nov18-dev.movespot.fyi/apis/konnect-search-1/versions/27234747-f0fe-432c-8be4-e6935419cdb6/operations/get-search-types"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-search-1/versions/27234747-f0fe-432c-8be4-e6935419cdb6.md

# List Search Types

`GET` `/search/types`

Operation ID: `get-search-types`

Retrieves a list of searchable Konnect entity types.

## Responses

- `200` - Search response for containing all searchable Konnect types.

## 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/types:
    get:
      operationId: get-search-types
      summary: List Search Types
      description: Retrieves a list of searchable Konnect entity types.
      responses:
        "200":
          $ref: "#/components/responses/SearchTypesResponse"
      tags:
        - Search
security:
  - personalAccessToken: []
  - systemAccountAccessToken: []
  - konnectAccessToken: []
components:
  responses:
    SearchTypesResponse:
      description: Search response for containing all searchable Konnect types.
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/SearchTypesResponse"
          examples:
            Searchable Entity Types:
              $ref: "#/components/examples/Searchable-Entity-Types"
  schemas:
    SearchTypesResponse:
      description: The collection of searchable entity types.
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              type:
                description: The entity type.
                type: string
              name:
                description: The human-readable entity name.
                type: string
              description:
                description: A short description of the entity.
                type: string
              attributes:
                description: The entity's searchable attributes.
                type: object
                additionalProperties:
                  $ref: "#/components/schemas/SearchTypesAttribute"
              regions:
                description: The regions the entity is available.
                type: array
                items:
                  type: string
            required:
              - type
              - name
              - description
              - regions
      title: SearchableEntityTypesResponse
    SearchTypesAttribute:
      description: Searchable attribute for the entity type.
      type: object
      properties:
        type:
          description: The attribute type.
          type: string
          enum:
            - string
            - number
            - boolean
            - array
        format:
          description: An optional hint at the contents and format of string types.
          type: string
          enum:
            - date-time
            - uuid
            - email
        items:
          description: An optional hint at the type of content in array types.
          type: object
          nullable: true
          properties:
            type:
              description: The attribute items' type.
              type: string
              enum:
                - string
                - number
                - boolean
          required:
            - type
        name:
          description: The human-readable attribute name.
          type: string
        description:
          description: A short description of the attribute.
          type: string
      required:
        - type
        - name
        - description
      title: SearchableEntityAttributesResponse
  examples:
    Searchable-Entity-Types:
      value:
        data:
          - type: user
            name: User
            description: A Konnect user
            attributes:
              created_at:
                type: string
                format: date-time
                name: Created At
                description: The time the user was created
              preferred_name:
                type: string
                name: Preferred Name
                description: The user's preferred name
              email:
                type: string
                format: email
                name: Email
                description: The user's email address
            regions:
              - global
          - type: system_account
            name: System Account
            description: A Konnect system account
            attributes:
              konnect_managed:
                type: boolean
                name: Konnect Managed
                description: Whether the system account is managed by Konnect
            regions:
              - global
          - type: api_product
            name: API Product
            description: A Konnect API Product
            regions:
              - us
              - eu
              - au
  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.
```
