action figshare_private_authors_search { label: "Search Authors" description: "Search for authors" provider: figshare method: POST path: "/account/authors/search" encoding: json input: { type: "object" properties: { group_id: { type: "integer" format: "int64" description: "Return only authors in this group or subgroups of the group" } institution_id: { type: "integer" format: "int64" description: "Return only authors associated to this institution" } is_active: { type: "boolean" description: "Return only active authors if True" } is_public: { type: "boolean" description: "Return only authors that have published items if True" } limit: { type: "integer" format: "int64" description: "Number of results included on a page. Used for pagination with query" } offset: { type: "integer" format: "int64" description: "Where to start the listing(the offset of the first result). Used for pagination with limit" } orcid: { type: "string" description: "Orcid of author" } order: { type: "string" description: "The field by which to order. Default varies by endpoint/resource." enum: ["published_date", "modified_date", "views", "shares", "downloads", "cites"] } order_direction: { type: "string" description: "Direction of ordering" enum: ["asc", "desc"] } page: { type: "integer" format: "int64" description: "Page number. Used for pagination with page_size" } page_size: { type: "integer" format: "int64" description: "The number of results included on a page. Used for pagination with page" } search_for: { type: "string" description: "Search term" } } } output: { type: "array" items: { type: "object" required: ["id", "full_name", "is_active", "url_name", "orcid_id"] properties: { full_name: { type: "string" description: "Author full name" } id: { type: "integer" format: "int64" description: "Author id" } is_active: { type: "boolean" description: "True if author has published items" } orcid_id: { type: "string" description: "Author Orcid" } url_name: { type: "string" description: "Author url name" } } } } }