users

Returns a list of users matching a given set of search criteria, with basic public information about each user.  Currently only username search is supported.

Resource URL

https://api.bibliocommons.com/v1/users

Request Parameters

Parameter Type Description Default Required?
q String The query string to search for.  Currently only username search is supported. N/A Yes

Response Fields

Response Field Type Description Returned Link To *
id String The user ID. Always
name String The user's username. Always profile_url
fullName String The user's full name. Always  
displayUserName Boolean

The user's preference for using their username, or full name. A true value indicates the user prefers the use of the username for display purposes, a false value indicates the user prefers their full name for display purposes.

Always  
profile_url String The URL for the user's profile page. Always

Example Request

GET https://api.bibliocommons.com/v1/users?q=exampleuser&api_key={key}

Response:

{
  "count": 1,
  "limit": 1,
  "pages": 1,
  "page": 1,    
  "users": [
    {
      "id": "2412321",
      "name": "belindabiblio",
      "fullName": "Belinda Biblio",
      "displayUserName": true,
      "profile_url": "https://anytown.bibliocommons.com/user_profile/2412321"
    }
  ] 
}