Skip to content

Commit 7c58e1f

Browse files
committed
Describe max_results attribute
1 parent 5cadcc2 commit 7c58e1f

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,13 @@ token2 = client.regenerate_token()
8080
token3 = client.get_access_token()
8181
```
8282

83+
### Searchs
84+
85+
By default a search (get_users, get_events, get_roles, get_groups) will return
86+
a max of results determined by the client parameter max_results (1000), but
87+
the search accept this parameter to get a different number of results.
88+
The max_results attribute of the client can be also overriden.
89+
8390
### Available Methods
8491

8592
```python
@@ -103,11 +110,11 @@ query_parameters = {
103110
}
104111
users_filtered2 = client.get_users(query_parameters)
105112

106-
# Get Users with limit
113+
/* Get 10 Users with role_id 2 */
107114
query_parameters = {
108-
"limit": 3
115+
"role_id": 2
109116
}
110-
users_filtered_limited = client.get_users(query_parameters)
117+
users_filtered_by_role_id = client.get_users(query_parameters, 10)
111118

112119
# Get User by id
113120
user = client.get_user(users_filtered[0].id)
@@ -203,11 +210,6 @@ event_types = client.get_event_types()
203210
# Get Events
204211
events = client.get_events()
205212

206-
query_events_params = {
207-
'limit': 2
208-
}
209-
events_limited = client.get_events(query_events_params)
210-
211213
# Get Event
212214
event = client.get_event(events[0].id)
213215

0 commit comments

Comments
 (0)