Read users
users_readReads site users and profiles, user groups, group permissions, ranks and profile fields.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Group id. | |
| gid | No | Group id. On group actions it is a synonym for id. | |
| nick | No | User login (nick), 2-25 characters. Synonym: user. | |
| page | No | List page, from 1. | |
| user | No | Synonym for nick. | |
| No | User email. | ||
| action | Yes | Operation to run. Each oneOf entry describes one action and lists its parameters. | |
| detail | No | Record form of a paged list. brief (default): id, login, full name, email, group, status (active or banned) and registration date (UTC, ISO 8601). Titles and excerpts are plain text; names, logins, paths, URLs and other identifiers are as the source gives them. full: complete records. A list reply is at most 30 KB and holds every record of its page: a record that does not fit in full comes in brief form, marked detail brief, the reply counts such records in brief_records, and get by id returns the complete record; brief records shorten their excerpts, then keep only their ids and titles. Only a page that does not fit even so is cut: truncated is true and next names the offset to go on from. | |
| offset | No | Records to skip from the start of a list; overrides page. A list reply cut at its size limit names the offset that follows in next. | |
| user_id | No | Numeric user id. | |
| per_page | No | Records per page: 1-50, 20 by default, larger values count as 50. |