List Users eligible to join a UserGroup

GET

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

GET

/api/v2/user-groups/:groupUUID/members/candidates

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

1 {
2   "row_count": 1,
3   "total_count": 1,
4   "users": [
5     {
6       "created_at": "2024-05-10T09:15:00Z",
7       "deleted_at": null,
8       "disable_default_ontology": false,
9       "email": "[email protected]",
10       "first_name": "Jane",
11       "id": 1024,
12       "last_name": "Doe",
13       "metadata": {},
14       "project_uuid": "a3f1c9d2-7b4e-4f8a-9c3d-2e5f6a7b8c9d",
15       "session_count": 42,
16       "time_zone": "America/New_York",
17       "updated_at": "2024-05-15T12:00:00Z",
18       "user_id": "user-7890",
19       "uuid": "d290f1ee-6c54-4b01-90e6-d701748f0851"
20     }
21   ]
22 }

Path parameters

groupUUIDstringRequired

UserGroup UUID

Query parameters

projectIdstringRequired

Project UUID

pageNumberintegerRequired

Page number

pageSizeintegerRequired

Page size

searchstringOptional

User search

Response

row_countintegerOptional

total_countintegerOptional

userslist of objectsOptional

Errors

403

Forbidden Error

404

Not Found Error

409

Conflict Error