---
updatedAt: 2025-06-04T21:28:18.000Z
agentTools:
  projectIndex: https://developer.simpplr.com/llms.txt
---

# Search within a Section

Use this API to search within Site, Top, File, User and Content.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "simpplr-api-gateway",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.ec.simpplr.com/api"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "oauth2",
        "flows": {}
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/search": {
      "get": {
        "summary": "Search within a Section",
        "description": "Use this API to search within Site, Top, File, User and Content.",
        "operationId": "search-within-a-section",
        "parameters": [
          {
            "name": "section",
            "in": "query",
            "description": "Section to search in",
            "required": true,
            "schema": {
              "type": "string",
              "enum": [
                "Site",
                "Top",
                "File",
                "User",
                "CrmFile",
                "ServiceNow",
                "GoogleDriveFile",
                "Content",
                "OneDriveFile",
                "SharePointFile",
                "Confluence"
              ],
              "default": "Site"
            }
          },
          {
            "name": "term",
            "in": "query",
            "description": "Search term",
            "schema": {
              "type": "string"
            }
          },
          {
            "name": "search-site",
            "in": "query",
            "schema": {
              "type": "boolean",
              "default": true
            }
          },
          {
            "name": "is-correction-enabled",
            "in": "query",
            "description": "Specifies if external seach can correct spelling. If false, the exact search term will be used. False should be passed when a suggested term is used to avoid infinite loops.",
            "schema": {
              "type": "boolean",
              "default": false
            }
          },
          {
            "name": "size",
            "in": "query",
            "description": "Maximum number of results to return",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 10
            }
          },
          {
            "name": "drive-type",
            "in": "query",
            "schema": {
              "type": "string",
              "enum": [
                "shareddrive",
                "mydrive"
              ]
            }
          },
          {
            "name": "x-user-email",
            "in": "header",
            "description": "User's email to login into Salesforce",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "200",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"status\": \"success\",\n    \"result\": {\n        \"totalRecords\": 11,\n        \"term\": \"test\",\n        \"suggestedTerm\": \"text\",\n        \"nextPageToken\": \"1\",\n        \"listOfItems\": [\n            {\n                \"relevancyScore\": 9.874037,\n                \"itemType\": \"site\",\n                \"item\": {\n                    \"url\": \"https://xxxxx.visualforce.com/apex/app?u=/site/a1A5e000001wK7IEAU/dashboard\",\n                    \"title\": \"Test API Site\",\n                    \"siteId\": \"a1A5e000001wxxxx\",\n                    \"name\": \"Test API Site\",\n                    \"memberCount\": 1,\n                    \"isShowInSimpplrEnabled\": false,\n                    \"isPageEnabled\": false,\n                    \"isOwner\": false,\n                    \"isMember\": false,\n                    \"isMandatory\": false,\n                    \"isManager\": false,\n                    \"isFileEnabled\": false,\n                    \"isFeedEnabled\": false,\n                    \"isFeatured\": false,\n                    \"isFavorited\": false,\n                    \"isEventEnabled\": false,\n                    \"isDeleted\": false,\n                    \"isBroadcast\": false,\n                    \"isActivated\": true,\n                    \"isAccessRequested\": false,\n                    \"isAboutEnabled\": false,\n                    \"id\": \"a1A5e000001wxxxx\",\n                    \"description\": \"\",\n                    \"chatterGroupId\": \"dummyId\",\n                    \"categoryName\": \"Uncategorized\",\n                    \"categoryId\": \"a1C5e0000006pbxxx\",\n                    \"category\": {\n                        \"url\": \"https://xxx.visualforce.com/apex/app?u=/sites#/sites/category?category=a1C5e0000006pbbEAA\",\n                        \"name\": \"Uncategorized\",\n                        \"id\": \"a1C5e0000006pxxxx\"\n                    },\n                    \"access\": \"Public\"\n                }\n            }\n        ]\n    },\n    \"responseTimeStamp\": \"1631630500574\",\n    \"message\": \"\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "example": "success"
                    },
                    "result": {
                      "type": "object",
                      "properties": {
                        "totalRecords": {
                          "type": "integer",
                          "example": 11,
                          "default": 0
                        },
                        "term": {
                          "type": "string",
                          "example": "test"
                        },
                        "suggestedTerm": {
                          "type": "string",
                          "example": "text"
                        },
                        "nextPageToken": {
                          "type": "string",
                          "example": "1"
                        },
                        "listOfItems": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "relevancyScore": {
                                "type": "number",
                                "example": 9.874037,
                                "default": 0
                              },
                              "itemType": {
                                "type": "string",
                                "example": "site"
                              },
                              "item": {
                                "type": "object",
                                "properties": {
                                  "url": {
                                    "type": "string",
                                    "example": "https://xxxxx.visualforce.com/apex/app?u=/site/a1A5e000001wK7IEAU/dashboard"
                                  },
                                  "title": {
                                    "type": "string",
                                    "example": "Test API Site"
                                  },
                                  "siteId": {
                                    "type": "string",
                                    "example": "a1A5e000001wxxxx"
                                  },
                                  "name": {
                                    "type": "string",
                                    "example": "Test API Site"
                                  },
                                  "memberCount": {
                                    "type": "integer",
                                    "example": 1,
                                    "default": 0
                                  },
                                  "isShowInSimpplrEnabled": {
                                    "type": "boolean",
                                    "example": false,
                                    "default": true
                                  },
                                  "isPageEnabled": {
                                    "type": "boolean",
                                    "example": false,
                                    "default": true
                                  },
                                  "isOwner": {
                                    "type": "boolean",
                                    "example": false,
                                    "default": true
                                  },
                                  "isMember": {
                                    "type": "boolean",
                                    "example": false,
                                    "default": true
                                  },
                                  "isMandatory": {
                                    "type": "boolean",
                                    "example": false,
                                    "default": true
                                  },
                                  "isManager": {
                                    "type": "boolean",
                                    "example": false,
                                    "default": true
                                  },
                                  "isFileEnabled": {
                                    "type": "boolean",
                                    "example": false,
                                    "default": true
                                  },
                                  "isFeedEnabled": {
                                    "type": "boolean",
                                    "example": false,
                                    "default": true
                                  },
                                  "isFeatured": {
                                    "type": "boolean",
                                    "example": false,
                                    "default": true
                                  },
                                  "isFavorited": {
                                    "type": "boolean",
                                    "example": false,
                                    "default": true
                                  },
                                  "isEventEnabled": {
                                    "type": "boolean",
                                    "example": false,
                                    "default": true
                                  },
                                  "isDeleted": {
                                    "type": "boolean",
                                    "example": false,
                                    "default": true
                                  },
                                  "isBroadcast": {
                                    "type": "boolean",
                                    "example": false,
                                    "default": true
                                  },
                                  "isActivated": {
                                    "type": "boolean",
                                    "example": true,
                                    "default": true
                                  },
                                  "isAccessRequested": {
                                    "type": "boolean",
                                    "example": false,
                                    "default": true
                                  },
                                  "isAboutEnabled": {
                                    "type": "boolean",
                                    "example": false,
                                    "default": true
                                  },
                                  "id": {
                                    "type": "string",
                                    "example": "a1A5e000001wxxxx"
                                  },
                                  "description": {
                                    "type": "string",
                                    "example": ""
                                  },
                                  "chatterGroupId": {
                                    "type": "string",
                                    "example": "dummyId"
                                  },
                                  "categoryName": {
                                    "type": "string",
                                    "example": "Uncategorized"
                                  },
                                  "categoryId": {
                                    "type": "string",
                                    "example": "a1C5e0000006pbxxx"
                                  },
                                  "category": {
                                    "type": "object",
                                    "properties": {
                                      "url": {
                                        "type": "string",
                                        "example": "https://xxx.visualforce.com/apex/app?u=/sites#/sites/category?category=a1C5e0000006pbbEAA"
                                      },
                                      "name": {
                                        "type": "string",
                                        "example": "Uncategorized"
                                      },
                                      "id": {
                                        "type": "string",
                                        "example": "a1C5e0000006pxxxx"
                                      }
                                    }
                                  },
                                  "access": {
                                    "type": "string",
                                    "example": "Public"
                                  }
                                }
                              }
                            }
                          }
                        }
                      }
                    },
                    "responseTimeStamp": {
                      "type": "string",
                      "example": "1631630500574"
                    },
                    "message": {
                      "type": "string",
                      "example": ""
                    }
                  }
                }
              }
            }
          },
          "401": {
            "description": "401",
            "content": {
              "application/json": {
                "examples": {
                  "Result": {
                    "value": "{\n    \"status\": \"error\",\n    \"message\": \"SESSION_TIMEOUT\",\n    \"i18nmessage\": \"SESSION_TIMEOUT\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "example": "error"
                    },
                    "message": {
                      "type": "string",
                      "example": "SESSION_TIMEOUT"
                    },
                    "i18nmessage": {
                      "type": "string",
                      "example": "SESSION_TIMEOUT"
                    }
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```