Users
Search Users
Users API endpoint performs a LinearB users paginated search
get/api/v1/users
Request
- Base URLhttps://public-api.linearb.io
- AuthAPI key in header x-api-key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
offsetinteger
page_sizeinteger
order_by'name' | 'email'
order_dir'ASC' | 'DESC'
search_by_field'name' | 'email'
search_termstring
user_role'admin' | 'editor' | 'viewer' | 'external' | 'basic'
An enumeration.
include_user_childrenboolean
Response
Successful Response
Changes
No recorded changes to this operation across all 1 revision of this API.