list

abstract fun list(email: String?, displayName: String?, id: String?, orgId: String? = null, max: Int, handler: CompletionHandler<List<Person>>)

Lists people in the authenticated user's organization.

Since

2.1.1

Parameters

email

: List people with this email address. For non-admin requests, either this or displayName are required.. (Derived parameter: Use MembershipClient.list to get the list of members. Then use Membership.personEmail to get the email address of the member)

displayName

: List people whose name starts with this string. For non-admin requests, either this or email are required.

id

: List people by ID. Accepts up to 85 person IDs separated by commas. (Derived parameter: Use MembershipClient.list to get the list of members. Then use Membership.personId to get the personId of the member).

orgId
  • List people in this organization. Only admin users of another organization (such as partners) may use this parameter. (Derived parameter: Use MembershipClient.list to get the list of members. Then use Membership.personOrgId to get the orgId of the member)

max

: The maximum number of people in the response.

handler

: A closure to be executed once the request has finished.


abstract fun list(email: String?, displayName: String?, max: Int, handler: CompletionHandler<List<Person>>)

Lists people in the authenticated user's organization.

Since

0.1

Parameters

email

: List people with this email address. For non-admin requests, either this or displayName are required.. (Derived parameter: Use MembershipClient.list to get the list of members. Then use Membership.personEmail to get the email address of the member)

displayName

: List people whose name starts with this string. For non-admin requests, either this or email are required.

max

: The maximum number of people in the response.

handler

: A closure to be executed once the request has finished.