FIfigshare
authors

Search Authors

Changed on

Search for authors

post/account/authors/search

Request

Request body

search_forstring

Search term

pageinteger

Page number. Used for pagination with page_size

page_sizeinteger

The number of results included on a page. Used for pagination with page

limitinteger

Number of results included on a page. Used for pagination with query

offsetinteger

Where to start the listing (the offset of the first result). Used for pagination with limit

institution_idinteger

Return only authors associated to this institution

orcidstring

Orcid of author

group_idinteger

Return only authors in this group or subgroups of the group

is_activeboolean

Return only active authors if True

is_publicboolean

Return only authors that have published items if True

Example request

{
  "search_for": "figshare",
  "page": 1,
  "page_size": 10,
  "limit": 10,
  "institution_id": 1
}

Response

OK. An array of authors

idinteger required

Author id

full_namestring required

Author full name

first_namestring required

Author first name

last_namestring required

Author last name

is_activeboolean required

True if author has published items

url_namestring required

Author url name

orcid_idstring required

Author Orcid

Example response

[
  {
    "id": 97657,
    "full_name": "John Doe",
    "first_name": "John",
    "last_name": "Doe",
    "url_name": "John_Doe",
    "orcid_id": "1234-5678-9123-1234"
  }
]

Changes

  • 5806e3dd43b2Revision changes
    • info

      added optional request body

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status