List Users eligible to join a UserGroup

GET

https://api.getzep.com/api/v2/user-groups/:groupUUID/members/candidates

AuthorizationApi-Key

Type “Api-Key” followed by a space and JWT token.

groupUUIDstringRequired

UserGroup UUID

projectIdstringRequired

Project UUID

pageNumberintegerRequired

Page number

pageSizeintegerRequired

Page size

searchstringOptional

User search

row_countintegerOptional

total_countintegerOptional

userslist of objectsOptional

403

Forbidden Error

404

Not Found Error

409

Conflict Error

1	from zep_cloud import Zep
2
3	client = Zep(
4	api_key="YOUR_API_KEY_HERE",
5	)
6
7	client.user_group.list_member_candidates(
8	group_uuid="groupUUID",
9	project_id="projectId",
10	page_number=1,
11	page_size=1,
12	)

1	{
2	"row_count": 1,
3	"total_count": 1,
4	"users": [
5	{
6	"created_at": "string",
7	"deleted_at": "string",
8	"disable_default_ontology": true,
9	"email": "string",
10	"first_name": "string",
11	"graph_uuid": "string",
12	"id": 1,
13	"last_name": "string",
14	"metadata": {},
15	"project_uuid": "string",
16	"session_count": 1,
17	"time_zone": "string",
18	"updated_at": "string",
19	"user_id": "string",
20	"uuid": "string"
21	}
22	]
23	}