API Reference

Suggested People List

This API retrieves a list of suggested people based on interest that has been added to the profile. To apply a filter, need to pass the JSON object with the title, company, and interest and set the variable value accordingly (i.e. the set company which needs to filter.). The areas that are used for the filter are company, job title, and interests To get all suggested attendees, in JSON object title, company, interest, and interest ID's should be an empty array and search. The string should be an empty string. To apply the search feature, need to pass the value on searchString and it would be searching on the attendee's first name, last name, interest, job title, and company.

Here are the fields for JSON Object that needs to pass while requesting.

FieldDescription
pageThis field represents the number of pages that can be used in the pagination of results.
sizeThis field represents the size of the result for the page.
searchStringThis field represents the string that is to be the search word for the result.
titleThis field represents an array of string names of titles that can be used in filter results.
companyThis field represents an array of string names of companies that can be used in filter results.
interestThis field represents an array of string names of interests that can be used in filter results.
interestIdsThis field represents an array of string ids of interests that can be used in filter results(specific for suggested people for rest pass empty).

Here is a description of the Response fields.

Field Description

recordsTotal

This field represents the total records in the event.

recordsFiltered

This field represents the number of records fetched via this API.

data

This field represents an array of people's objects.

id

This field represents the people's ID.

userId

This field represents the user ID.

firstName

This field represents the first name of the user.

lastName

This field represents the last name of the user.

pronouns

This field represents the pronouns of the user.

photo

This field represents the photo of the user.

coverPhoto

This field represents the cover photo of the user.

acceptDirectMessages

This field represents whether the user accepts direct messages or not.

acceptMeetingRequests

This field represents the accessibility of accepting a meeting request.
Example:
Everyone - Any user can send a meeting request to this user.
My Connection - Only connected users can send a meeting request.
No one - No user can send a meeting request to this user.

showContactInfo

This field represents whether the user wants to show their contact info or not.

company

This field represents the user's company.

title

This field represents the user's title.

timezoneId

This field represents the user's time zone.

equivalentTimezone

This field represents the user's equivalent time zone.

status

This field represents the connection status of the user.

rejectedBy

This field represents the ID of rejected by the user.

eventId

This field represents the event ID.

videoIntro

This field represents the video intro URL.

extraInfo

This field represents extra information fields including
about me, wants to learn, knows, wants to meet.

interests

This field represents the interests of the user.

availabilityDuration

This field represents the availability duration of the user.

request

This field represents connection status is request type or not.

instagram

This field represents the Instagram URL of the user.

facebook

This field represents the Facebook URL of the user.

twitter

This field represents the Twitter URL of the user.

linkedIn

This field represents the LinkedIn URL of the user.

availabilityStartTime

This field represents the availability start time of the user for meetings.

availabilityEndTime

This field represents the availability end time of the user for meetings.

availabilityTimezoneId

This field represents the availability time zone ID of the user for the meeting.

showProfile

This field represents whether the user's profile will be shown or not.

rules

This field represents the meeting availability rule of the user.

meetingAvailabilitySetted

This field represents if the meeting availability rule is defined or not.

emailNotification

This field represents if email notifications are enabled or not.

allowCallsAndVideosFromNotConnectedAttendees

This field represents is the user allows calls and videos from not connected attendees or not.

exposeProfileToOtherUser

This field represents whether the user want to expose their profile to others or not.

user

This field represents the user ID.

Here is a Description for Error Code.

Response status codeError CodeDescription
4014010101You are not authorized.
404Request path not found.
405Request method not supported.
Language
Credentials
Header
Click Try It! to start a request and see the response here!