Contents x
Gets all the readers available in the project
  • 09 Mar 2023
  • 1 Minute to read
  • Contributors
  • Print
  • Dark
    Light
Contents

Gets all the readers available in the project

  • Updated on 09 Mar 2023
  • 1 Minute to read
  • Contributors
  • Print
  • Dark
    Light
Get
/v1/Readers

Security
API Key
Header parameter nameapi_token
Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens
Query parameters
searchEmail
string

Search readers based on the email id. This is optional.

Responses
200

Success

Expand All

object

data
Array of object


object

reader_id
string 


first_name
string 


last_name
string 


email_id
string 


last_login_at
string 


extension_data
object


context
object

extension_data
 

caller_reference
string 


success
boolean 


errors
Array of object


object

extension_data
 

stack_trace
string 

Stack trace for error response message


description
string 

Description for error cause


error_code
string 

Error code for Api resonse


custom_data
object


warnings
Array of object


object

extension_data
 

description
string 

Warning description


warning_code
string 

warning code for customer Api base response


information
Array of object


object

extension_data
 

description
string 

status description for customer Api response information


feature_explorer_status
object

feature_usage_score
number 


section
integer 

Valid values[0,1,2,3,4,5]
feature_id
string 


feature_name
integer 

Valid values[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26]
advanced_feature_user_role
integer 

Valid values[0,1,2]
feature_explorer_user_analytics
object

id
string 


project_id
string 


user_id
string 


trophy_status
object

first
boolean 


second
boolean 


third
boolean 


fourth
boolean 


show_default
boolean 


show_advanced_section_popup
boolean 


hide_popup
boolean 


hide_popup_date
string 


is_advanced_section_unlocked
boolean 


usage_score
number 


features
Array of object


object

section
integer 

Valid values[0,1,2,3,4,5]
feature_name
integer 

Valid values[0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23,24,25,26]
is_feature_explored
boolean 


time_stamp
string 


is_closed_content_reuse_info
boolean 


Was this article helpful?
What's Next