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

# Search for People

Use this API to search for People in your organisation.

# 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": {
    "/people": {
      "get": {
        "summary": "Search for People",
        "description": "Use this API to search for People in your organisation.",
        "operationId": "search-for-people",
        "parameters": [
          {
            "name": "search-param",
            "in": "query",
            "description": "Narrow down the search to Department / Location / Expertise",
            "required": true,
            "schema": {
              "type": "string",
              "enum": [
                "Department",
                "Location",
                "Expertise",
                null
              ],
              "default": "Department"
            }
          },
          {
            "name": "size",
            "in": "query",
            "description": "Maximum number of results to return",
            "required": true,
            "schema": {
              "type": "integer",
              "format": "int32",
              "default": 16
            }
          },
          {
            "name": "term",
            "in": "query",
            "description": "Search term",
            "required": true,
            "schema": {
              "type": "string",
              "default": "null"
            }
          },
          {
            "name": "department",
            "in": "query",
            "description": "The user's department",
            "schema": {
              "type": "string",
              "default": "null"
            }
          },
          {
            "name": "location",
            "in": "query",
            "description": "The user's location",
            "schema": {
              "type": "string",
              "default": "null"
            }
          },
          {
            "name": "user-category",
            "in": "query",
            "schema": {
              "type": "string",
              "default": "all"
            }
          },
          {
            "name": "expertise",
            "in": "query",
            "schema": {
              "type": "string",
              "default": "null"
            }
          },
          {
            "name": "limit-to-subsegment",
            "in": "query",
            "schema": {
              "type": "boolean",
              "default": true
            }
          },
          {
            "name": "sort-by",
            "in": "query",
            "description": "Technique for sorting results",
            "schema": {
              "type": "string",
              "default": "alphabetical"
            }
          },
          {
            "name": "include-total",
            "in": "query",
            "schema": {
              "type": "boolean",
              "default": true
            }
          },
          {
            "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\": 6,\n        \"listOfItems\": [\n            {\n                \"videoCallProvider\": \"zoom\",\n                \"url\": \"https://xxxxx.visualforce.com/apex/app?u=/people/a115e000000abUDAAY\",\n                \"sfUserId\": \"0055e000006Flxxxxx\",\n                \"peopleId\": \"a115e000000abxxxxx\",\n                \"nickname\": \"User16279616049595xxxxx\",\n                \"name\": \"Ajay Hada\",\n                \"location\": \"\",\n                \"isProtectedAuthor\": false,\n                \"isOwner\": false,\n                \"isMember\": false,\n                \"isManager\": false,\n                \"isFollowing\": false,\n                \"isFollower\": false,\n                \"isFavorited\": false,\n                \"isContentManager\": false,\n                \"isActive\": true,\n                \"id\": \"a115e000000axxxxx\",\n                \"hasConnectedSharePointAccount\": false,\n                \"hasConnectedOneDriveAccount\": false,\n                \"hasConnectedGoogleDriveAccount\": false,\n                \"hasConnectedDropboxAccount\": false,\n                \"email\": \"xxxxx@simpplr.com\",\n                \"canRemove\": true,\n                \"canMakeOwner\": true,\n                \"canMakeNotManager\": false,\n                \"canMakeNotContentManager\": false,\n                \"canMakeManager\": true,\n                \"canMakeContentManager\": true,\n                \"canFollow\": true\n            }\n        ]\n    },\n    \"responseTimeStamp\": \"1631627196966\",\n    \"message\": \"\"\n}"
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "status": {
                      "type": "string",
                      "example": "success"
                    },
                    "result": {
                      "type": "object",
                      "properties": {
                        "totalRecords": {
                          "type": "integer",
                          "example": 6,
                          "default": 0
                        },
                        "listOfItems": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "videoCallProvider": {
                                "type": "string",
                                "example": "zoom"
                              },
                              "url": {
                                "type": "string",
                                "example": "https://xxxxx.visualforce.com/apex/app?u=/people/a115e000000abUDAAY"
                              },
                              "sfUserId": {
                                "type": "string",
                                "example": "0055e000006Flxxxxx"
                              },
                              "peopleId": {
                                "type": "string",
                                "example": "a115e000000abxxxxx"
                              },
                              "nickname": {
                                "type": "string",
                                "example": "User16279616049595xxxxx"
                              },
                              "name": {
                                "type": "string",
                                "example": "Ajay Hada"
                              },
                              "location": {
                                "type": "string",
                                "example": ""
                              },
                              "isProtectedAuthor": {
                                "type": "boolean",
                                "example": false,
                                "default": true
                              },
                              "isOwner": {
                                "type": "boolean",
                                "example": false,
                                "default": true
                              },
                              "isMember": {
                                "type": "boolean",
                                "example": false,
                                "default": true
                              },
                              "isManager": {
                                "type": "boolean",
                                "example": false,
                                "default": true
                              },
                              "isFollowing": {
                                "type": "boolean",
                                "example": false,
                                "default": true
                              },
                              "isFollower": {
                                "type": "boolean",
                                "example": false,
                                "default": true
                              },
                              "isFavorited": {
                                "type": "boolean",
                                "example": false,
                                "default": true
                              },
                              "isContentManager": {
                                "type": "boolean",
                                "example": false,
                                "default": true
                              },
                              "isActive": {
                                "type": "boolean",
                                "example": true,
                                "default": true
                              },
                              "id": {
                                "type": "string",
                                "example": "a115e000000axxxxx"
                              },
                              "hasConnectedSharePointAccount": {
                                "type": "boolean",
                                "example": false,
                                "default": true
                              },
                              "hasConnectedOneDriveAccount": {
                                "type": "boolean",
                                "example": false,
                                "default": true
                              },
                              "hasConnectedGoogleDriveAccount": {
                                "type": "boolean",
                                "example": false,
                                "default": true
                              },
                              "hasConnectedDropboxAccount": {
                                "type": "boolean",
                                "example": false,
                                "default": true
                              },
                              "email": {
                                "type": "string",
                                "example": "xxxxx@simpplr.com"
                              },
                              "canRemove": {
                                "type": "boolean",
                                "example": true,
                                "default": true
                              },
                              "canMakeOwner": {
                                "type": "boolean",
                                "example": true,
                                "default": true
                              },
                              "canMakeNotManager": {
                                "type": "boolean",
                                "example": false,
                                "default": true
                              },
                              "canMakeNotContentManager": {
                                "type": "boolean",
                                "example": false,
                                "default": true
                              },
                              "canMakeManager": {
                                "type": "boolean",
                                "example": true,
                                "default": true
                              },
                              "canMakeContentManager": {
                                "type": "boolean",
                                "example": true,
                                "default": true
                              },
                              "canFollow": {
                                "type": "boolean",
                                "example": true,
                                "default": true
                              }
                            }
                          }
                        }
                      }
                    },
                    "responseTimeStamp": {
                      "type": "string",
                      "example": "1631627196966"
                    },
                    "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
}
```