b2evolution b2evolution

  • Sign in
  • Sign up
  • About
  • Downloads
  • Hosting
  • Docs
  • Support
  • Sign in
  • Sign up
  • Manuals Home
  • Latest Updates
 
  1. b2evolution CMS User Manual
  2. Advanced Topics
  3. Using the APIs
  4. REST API or RESTful API
  5. List Users (REST)

List Users (REST)

GET <baseurl>/api/v1/users

This lists the users as API equivalent of disp = users.

Parameters

Possible request params

Name

Type

Description

Default

paged

integer

Page number

1

page

integer

Page number, when page is defined then it is used instead of paged

1

per_page

integer

Count users per page

10

filter

string

How to update the users list:

  • new - Update filters to new requested values
  • refresh - Refresh the cached result to new changes
  • reset - Reset the users list to default filters

restrict_to_available_fileroots

integer

Additional restriction of collections for current user
Possible values: 1 - Load collections ONLY with available file roots to view by current user

0

gender_men

integer

1 - to filter only men

0

gender_women

integer

1 - to filter only women

0

keywords

string

Find the requested keywords in the user fields user_login, user_firstname, user_lastname, user_nickname, user_email by mask *keyword* in each field

q

string

This is alias for the param keywords, see above.

country

integer

Country ID

region

integer

Region ID

subregion

integer

Sub-region ID

city

integer

City ID

age_min

integer

Minimum age

age_max

integer

Maximum age

level_min

integer

Minimum user level

level_max

integer

Maximum user level

org

integer

Organization ID

criteria_type%5B%5D

array

Specific criteria user field ID.
(If this was unencoded it would actually read criteria_type[])

criteria_value%5B%5D

array

Specific criteria user field keyword.
(If this was unencoded it would actually read criteria_value[])

Response

Response is an array of the following properties:

Name

Type

Description

found

integer

Number of found users

page

integer

Current page

page_size

integer

Number users per page

pages_total

integer

Number of total pages

users

array

Array of users:

Name

Type

Description

id

integer

User ID

picture

string

URL of user profile picture

login

string

Login

fullname

string

Full name

city

string

City

Errors

Possible Error Codes

Error code

HTTP response

Message

unknown_controller

404

Unknown user controller "<user_controller>"

no_access

403

You must log in to view the user directory.

no_access

403

You must activate your account before you can view the user directory.

no_access

403

Your account status currently does not permit to view the user directory.

no_access

403

Please specify your country before attempting to contact other users..

no_users

404

No users found

Used for:

  • Search users in modal window of file browser menu option "User roots -> Other…" in order to switch a selected user File Root
Created by yurabakhtin • Last edit by yurabakhtin on 2019-09-11 14:45 • •

No feedback yet

On this page

  • Parameters
  • Response
  • Errors
  • Used for:

Search the Manual

Content Hierarchy

  • b2evolution CMS User Manual
  • User's Guide
  • Installation / Upgrade
  • Front-office Reference
  • Back-office Reference
  • Developer Reference
  • Operations Reference
  • Advanced Topics
    • Using Desktop Blogging Tools
    • Using Blogging Apps
    • Blogging by email
    • Using the APIs
      • REST API or RESTful API
        • List Collections (REST)
        • List Posts (REST)
        • List Items (REST)
        • Retrieve a Post (REST)
        • Retrieve any item (REST)
        • Search (REST)
        • List Users (REST)
        • Retrieve a User (REST)
        • Create a User (REST)
        • Update a User (REST)
        • Delete a User (REST)
        • Cookie Authentication (REST)
        • Basic HTTP Authentication (REST)
      • B2 API
      • API Error Codes
      • Blogger API
      • MetaWeblog API
      • MovableType API
    • Contributing
    • Translations (i18n/l10n)
    • Monetizing
    • How to...
    • Podcasting
  • Glossary
  • Archives
Web Site Engine

This online manual is powered by b2evolution CMS – A complete engine for your website.

About b2evolution

  • What is it?
  • Features
  • Getting Started
  • Screenshots
  • Online demo
  • Testimonials
  • Design philosophy
  • Free & open source
  • Terms of service

Downloads

  • Latest releases
  • Skins
  • Plugins
  • Language packs

About us

  • About us
  • Contact

Webhosting Guide

  • Web hosting blog
  • Best web hosting
  • Cheap web hosting
  • Green web hosting
  • Hosting with SSH
  • VPS hosting
  • Dedicated servers
  • Reseller hosting
  • Int'l: UK / France

Docs & Support

  • Online manual
  • Forums
  • Hire a pro !

Other

  • Adsense
  • Press room
  • Privacy policy

Stay in touch

  • GitHub
  • Twitter
  • Facebook
  • LinkedIn
  • News blog
  • RSS feed
  • Atom feed

Founded & Maintained by François Planque