Sign in

v2

latestOpenAPI 3.0.3Apache 2.02026-07-31158109678.6 KB
institutions

Private Account Institution Accounts Search

Returns the accounts for which the account has administrative privileges (assigned and inherited).

post/account/institution/accounts/search

Request body

search_forstring

Search term

is_activeinteger

Filter by active status

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_user_idstring

filter by institution_user_id

emailstring

filter by email

Example request

{
  "search_for": "figshare",
  "page": 1,
  "page_size": 10,
  "limit": 10,
  "institution_user_id": "alan",
  "email": "alan@institution.com"
}

Response

OK. An array of Accounts

idinteger required

Account id

first_namestring required

First Name

last_namestring required

Last Name

institution_idinteger required

Account institution

emailstring required

User email

activeinteger required

Account activity status

institution_user_idstring required

Account institution user id

quotainteger required

Total storage available to account, in bytes

used_quotainteger required

Storage used by the account, in bytes

user_idinteger required

User id associated with account, useful for example for adding the account as an author to an item

orcid_idstring required

ORCID iD associated to account

symplectic_user_idstring required

Symplectic ID associated to account

Example response

[
  {
    "id": 1495682,
    "first_name": "Doe",
    "last_name": "John",
    "institution_id": 1,
    "email": "user@domain.com",
    "institution_user_id": "1",
    "quota": 1074000000,
    "used_quota": 1074000000,
    "user_id": 1000001,
    "orcid_id": "0000-0001-2345-6789",
    "symplectic_user_id": "djohn42"
  }
]