openapi: 3.2.0 info: title: simpplr-api-gateway People API version: '1.0' servers: - url: https://api.ec.simpplr.com/api security: - sec0: [] tags: - name: People 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 tags: - People /people/{people-id}: put: summary: Update People description: Use this API to update People details. operationId: update-people parameters: - name: people-id in: path description: ID of the People to be updated schema: type: string default: a114W00000L52oWQAR required: true - name: x-user-email in: header description: User's email to login into Salesforce required: true schema: type: string requestBody: content: application/json: schema: type: object properties: aboutme: type: string default: 'null' company-name: type: string description: Name of the Company default: Simpplr custom-user-field-list: type: string default: '[]' joining-date: type: string description: Joining Date default: '2021-09-01' format: date manager: type: string description: Manager ID default: 'null' people-category-id: type: string default: 'null' salesforce-language-locale-key: type: string default: en-US simpplr-language-locale-key: type: string default: en-US time-zone: type: string description: Time Zone default: Asia/Kolkata zoom-id: type: string description: Zoom ID default: 'null' birthday-month: type: string description: Birth Month default: 'null' city: type: string description: City default: 'null' country: type: string description: Country default: 'null' department: type: string description: Department default: 'null' division: type: string description: Division default: 'null' first-name: type: string description: First Name default: 'null' last-name: type: string description: Last Name default: 'null' extension: type: string default: '+1' mobile: type: string description: Mobile Number default: 'null' phone: type: string description: Phone Number default: 'null' state: type: string description: State default: 'null' street: type: string description: Street default: 'null' title: type: string description: Title default: 'null' user-category: type: string default: 'null' responses: '200': description: '200' content: application/json: examples: Result: value: "{\n \"status\": \"success\",\n \"result\": {\n \"timeZone\": \"Asia/Kolkata\",\n \"simpplrLanguageLocaleKey\": \"en-US\",\n \"salesforceLanguageLocaleKey\": \"en-US\",\n \"peopleId\": \"a114W00000L5xxxxx\",\n \"joiningDate\": \"2020-11-05\",\n \"customUserFieldList\": [],\n \"birthdayMonth\": \"\"\n },\n \"responseTimeStamp\": \"1631629881555\",\n \"redirectUrl\": \"https://xxxx.visualforce.com/apex/MySettingsProfile?peopleId=a114W00000xxxxx&ts=1631629881550\",\n \"message\": \"\"\n}" schema: type: object properties: status: type: string example: success result: type: object properties: timeZone: type: string example: Asia/Kolkata simpplrLanguageLocaleKey: type: string example: en-US salesforceLanguageLocaleKey: type: string example: en-US peopleId: type: string example: a114W00000L5xxxxx joiningDate: type: string example: '2020-11-05' customUserFieldList: type: array birthdayMonth: type: string example: '' responseTimeStamp: type: string example: '1631629881555' redirectUrl: type: string example: https://xxxx.visualforce.com/apex/MySettingsProfile?peopleId=a114W00000xxxxx&ts=1631629881550 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 tags: - People components: securitySchemes: sec0: type: oauth2 flows: {} x-readme-fauxas: true x-provenance: method: searched source: https://developer.simpplr.com/reference harvested: '2026-10-14' tool: harvest-readme-openapi.py note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored. assembled_from: - https://developer.simpplr.com/reference/add-a-follower-to-a-site.md - https://developer.simpplr.com/reference/add-a-member-to-a-site.md - https://developer.simpplr.com/reference/add-audience.md - https://developer.simpplr.com/reference/app-adoption-1.md - https://developer.simpplr.com/reference/app-adoption-average.md - https://developer.simpplr.com/reference/app-adoption.md - https://developer.simpplr.com/reference/app-page-views.md - https://developer.simpplr.com/reference/autocomplete.md - https://developer.simpplr.com/reference/campaigns.md - https://developer.simpplr.com/reference/content-engagement.md - https://developer.simpplr.com/reference/content-publications.md - https://developer.simpplr.com/reference/content-referral-sources.md - https://developer.simpplr.com/reference/content-views-by-type.md - https://developer.simpplr.com/reference/content-views-list.md - https://developer.simpplr.com/reference/create-a-blog.md - https://developer.simpplr.com/reference/create-a-new-alert.md - https://developer.simpplr.com/reference/create-a-notification.md - https://developer.simpplr.com/reference/create-a-site.md - https://developer.simpplr.com/reference/create-an-event.md - https://developer.simpplr.com/reference/delete-a-blog.md - https://developer.simpplr.com/reference/delete-a-page-by-id.md - https://developer.simpplr.com/reference/delete-album-images-by-ids.md - https://developer.simpplr.com/reference/delete-an-alert.md - https://developer.simpplr.com/reference/delete-an-event-by-id.md - https://developer.simpplr.com/reference/delete-audience.md - https://developer.simpplr.com/reference/expire-an-alert.md - https://developer.simpplr.com/reference/get-all-events.md - https://developer.simpplr.com/reference/get-blog-by-id.md - https://developer.simpplr.com/reference/get-carousel-data.md - https://developer.simpplr.com/reference/get-must-read-content.md - https://developer.simpplr.com/reference/get-site-by-id.md - https://developer.simpplr.com/reference/knowledge-page-stats.md - https://developer.simpplr.com/reference/low-activity-sites.md - https://developer.simpplr.com/reference/news-letters.md - https://developer.simpplr.com/reference/people-count.md - https://developer.simpplr.com/reference/people-performance.md - https://developer.simpplr.com/reference/people-profile-completeness.md - https://developer.simpplr.com/reference/remove-a-follower-from-a-site.md - https://developer.simpplr.com/reference/remove-a-member-from-a-site.md - https://developer.simpplr.com/reference/search-for-a-page-by-id.md - https://developer.simpplr.com/reference/search-for-alerts.md - https://developer.simpplr.com/reference/search-for-an-event-by-id.md - https://developer.simpplr.com/reference/search-for-contents.md - https://developer.simpplr.com/reference/search-for-notifications.md - https://developer.simpplr.com/reference/search-for-people.md - https://developer.simpplr.com/reference/search-for-site-by-id.md - https://developer.simpplr.com/reference/search-for-sites.md - https://developer.simpplr.com/reference/search-list-1.md - https://developer.simpplr.com/reference/search-list.md - https://developer.simpplr.com/reference/search-page-categories.md - https://developer.simpplr.com/reference/search-within-a-section.md - https://developer.simpplr.com/reference/search-within-feed.md - https://developer.simpplr.com/reference/searches.md - https://developer.simpplr.com/reference/site-count.md - https://developer.simpplr.com/reference/site-popularity.md - https://developer.simpplr.com/reference/site-publications.md - https://developer.simpplr.com/reference/social-engagement-list.md - https://developer.simpplr.com/reference/social-engagement.md - https://developer.simpplr.com/reference/update-a-blog.md - https://developer.simpplr.com/reference/update-a-notification.md - https://developer.simpplr.com/reference/update-a-page.md - https://developer.simpplr.com/reference/update-a-site.md - https://developer.simpplr.com/reference/update-an-alert.md - https://developer.simpplr.com/reference/update-an-event.md - https://developer.simpplr.com/reference/update-audience.md - https://developer.simpplr.com/reference/update-people.md - https://developer.simpplr.com/reference/update-site-as-active.md merge: pages: 67 deduped: 66 conflicts_kept_first: 0