Get readers
  • 30 Jun 2021
  • 1 Minute to read
  • Contributors
  • Dark
    Light

Get readers

  • Dark
    Light

GET/readers

Gets all the readers in the project


Parameter Type Description
api_token string REST API key you can obtain from Settings > Advanced > API tokens.

Route Parameters

You can filter results using the following parameters

Parameter Type Description
searchEmail string Filter readers by Email. Not required to specify the full Email address.

Sample Response

{
  "data": [
    {
      "reader_id": "02d612ec-bb32-469b-89ea-1d61e2ef5ce5",
      "first_name": null,
      "last_name": null,
      "email_id": "danny.brown@document360.com",
      "last_login_at": null
    },
    {
      "reader_id": "56759034-2e69-46c6-9ae3-a4c173f47757",
      "first_name": "John",
      "last_name": "Peterson",
      "email_id": "john.p@document360.com",
      "last_login_at": "2020-11-11T08:26:07.014Z"
    },
  ],
  "extension_data": null,
  "context": null,
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}

Response Data

Parameter Type Description
reader_id string ID of the reader.
first_name string First name of the reader. This value would be null until the reader logs in and update their profile details.
last_name string Last name of the reader. This value would be null until the reader logs in and update their profile details.
email_id string Email address of the reader.
last_login_at string The last login date and time by reader. This value would be null until the reader logs in.

Was this article helpful?

What's Next