LogoLogo
CommunitySupportR2R GitHub
IntroductionDocumentationAPI & SDKsCookbooksSelf Hosting
IntroductionDocumentationAPI & SDKsCookbooksSelf Hosting
  • API Documentation
    • R2R API & SDKs
  • API & SDKs
CommunitySupportR2R GitHub
API & SDKsUsers

List Users

GET
https://api.sciphi.ai/v3/users
GET
/v3/users
1from r2r import R2RClient
2
3client = R2RClient()
4# client.login(...)
5
6# List users with filters
7users = client.users.list(
8 offset=0,
9 limit=100,
10)
Try it
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 "limits_overrides": {
21 "key": "value"
22 },
23 "metadata": {
24 "key": "value"
25 },
26 "verification_code_expiry": "2024-01-15T09:30:00Z",
27 "name": "name",
28 "bio": "bio",
29 "profile_picture": "profile_picture",
30 "total_size_in_bytes": 1,
31 "num_files": 1,
32 "account_type": "account_type",
33 "hashed_password": "hashed_password",
34 "google_id": "google_id",
35 "github_id": "github_id"
36 }
37 ],
38 "total_entries": 1
39}
List all users with pagination and filtering options. Only accessible by superusers.

Headers

AuthorizationstringRequired
Bearer authentication of the form `Bearer <token>`, where token is your auth token.
X-API-KeystringRequired

Query parameters

idsstringOptional
List of user IDs to filter by
offsetintegerOptional>=0Defaults to 0
Specifies the number of objects to skip. Defaults to 0.
limitintegerOptional>=1<=1000Defaults to 100
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

Was this page helpful?
Previous

Register

Next
Built with
List of user IDs to filter by
Specifies the number of objects to skip. Defaults to 0.
Specifies a limit on the number of objects to return, ranging between 1 and 100. Defaults to 100.
Successful Response

Bearer authentication of the form Bearer <token>, where token is your auth token.