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 screen name. Always profile_url
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": "exampleuser",
      "profile_url": "http://examplepl.bibliocommons.com/collection/show/2412321"
    }
  ] 
}