Skip to content

Commit

Permalink
Update apiary.apib
Browse files Browse the repository at this point in the history
Co-authored-by: mrnyax <nyakoria@gmail.com>
  • Loading branch information
tkrisztian95 and mrnyax committed Oct 6, 2023
1 parent 0eefa3f commit 82ffc1d
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion apiary.apib
Original file line number Diff line number Diff line change
Expand Up @@ -1422,7 +1422,7 @@ The example response includes the pagination URLs and query parameters in the `l

If you're managing a large number of users, you can benefit from the query params `includeCustomField` and `excludeProperties`.

By default all custom field is returned nested in the user model.
By default all custom fields are returned nested in the user model.
Using the `includeCustomField` can help reduce the data transferred and fetch the only custom fields that are needed.
When specified, only the few custom fields are returned, that are found with the given key passed in the param value.
To include more than one simply append N times the `&includeCustomField={Key}` to the request.
Expand Down

0 comments on commit 82ffc1d

Please sign in to comment.