List all users

GET

List all users with pagination and filtering options. Only accessible by superusers.

Query parameters

idsstringOptional

List of user IDs to filter by

offsetintegerOptional

Specifies the number of objects to skip. Defaults to 0.

limitintegerOptional

Specifies a limit on the number of objects to return, ranging between 1 and 100. Defaults to 100.

Response

Successful Response

resultslist of objects

total_entriesinteger

Errors

GET

1 from r2r import R2RClient
2 
3 client = R2RClient("http://localhost:7272")
4 # client.login(...)
5 
6 # List users with filters
7 users = client.users.list(
8     offset=0,
9     limit=100,
10 )

1 {
2   "results": [
3     {
4       "id": "id",
5       "email": "email",
6       "is_active": true,
7       "is_superuser": true,
8       "created_at": "2024-01-15T09:30:00Z",
9       "updated_at": "2024-01-15T09:30:00Z",
10       "is_verified": true,
11       "collection_ids": [
12         "collection_ids"
13       ],
14       "graph_ids": [
15         "graph_ids"
16       ],
17       "document_ids": [
18         "document_ids"
19       ],
20       "hashed_password": "hashed_password",
21       "verification_code_expiry": "2024-01-15T09:30:00Z",
22       "name": "name",
23       "bio": "bio",
24       "profile_picture": "profile_picture",
25       "total_size_in_bytes": 1,
26       "num_files": 1
27     }
28   ],
29   "total_entries": 1
30 }

Built with

1	from r2r import R2RClient
2
3	client = R2RClient("http://localhost:7272")
4	# client.login(...)
5
6	# List users with filters
7	users = client.users.list(
8	offset=0,
9	limit=100,
10	)

1	{
2	"results": [
3	{
4	"id": "id",
5	"email": "email",
6	"is_active": true,
7	"is_superuser": true,
8	"created_at": "2024-01-15T09:30:00Z",
9	"updated_at": "2024-01-15T09:30:00Z",
10	"is_verified": true,
11	"collection_ids": [
12	"collection_ids"
13	],
14	"graph_ids": [
15	"graph_ids"
16	],
17	"document_ids": [
18	"document_ids"
19	],
20	"hashed_password": "hashed_password",
21	"verification_code_expiry": "2024-01-15T09:30:00Z",
22	"name": "name",
23	"bio": "bio",
24	"profile_picture": "profile_picture",
25	"total_size_in_bytes": 1,
26	"num_files": 1
27	}
28	],
29	"total_entries": 1
30	}