Core Tools¶

The core_* tools look up people and groups in the user's organisation. Other tools return people as ids, and an assistant uses these tools to turn them into names, or to find the right person to mention.

All three tools are in the core tool group and need only Huddo itself.

core_find_people¶

Finds people, and optionally groups, in the user's organisation by name or email. Use it to find someone to mention, share with or add as a member.

Read-only · Needs: Huddo

Parameter	Type	Required	Default	Notes
`query`	string	Yes		A name or email, 1 to 200 characters
`kind`	string	No	`people`	One of `people`, `groups` or `both`
`limit`	integer	No	20	1 to 25, for each of people and groups
`includeMe`	boolean	No	false	Include the signed-in user in the results

Returns: people, each with id, name and email, and groups, each with id, name and kind (the kind of group, such as a Microsoft Team).

Example: "Find Sam Lee so you can mention them in the comment."

core_get_people¶

Turns user ids from other tools' results (creators, voters, members, actors) into names.

Read-only · Needs: Huddo

Parameter	Type	Required	Default	Notes
`userIds`	array of user ids	Yes		1 to 50 ids

Returns: people, each with id and name. An id the user isn't allowed to see comes back with the id alone.

Example: "Who are the people who voted for that idea?"

core_org_members¶

Lists the members of the user's organisation, or of another organisation they belong to, with each member's role: admin, member or guest. Pending invitations are left out. Any member of the organisation can use it.

Read-only · Needs: Huddo

Parameter	Type	Required	Default	Notes
`query`	string	No		A name or email prefix, up to 200 characters
`limit`	integer	No	20	1 to 50
`orgId`	id	No	The current organisation	Another organisation the user belongs to

Returns: orgId, members (each with userId, name and role) and total, the number of members that match.

Example: "Who are the admins in our organisation?"