API Docs

__METHOD= GET . __PATH= /almaws/v1/users .

Retrieve users

This API returns a list of Users, sorted by last name.

Resource URL

GET /almaws/v1/users

API Description

URL Parameters

None

Querystring Parameters

ParameterTypeRequiredDescription
limitxs:intOptional. Default: 10Limits the number of results. Optional. Valid values are 0-100. Default value: 10.
offsetxs:intOptional. Default: 0Offset of the results returned. Optional. Default value: 0, which means that the first results will be returned.
qxs:stringOptional.Search query. Optional. Searching for words from: primary_id, first_name, last_name, middle_name, email, job_category, identifiers, general_info and ALL. Example (note the tilde between the code and text): q=last_name~Smith (see Brief Search)
order_byxs:stringOptional. Default: last_name, first_name, primary_idA few sort options are available: last_name, first_name and primary_id. One sort option may be used at a time. A secondary sort key, primary_id, is added if last_name or first_name is the primary sort. Default sorting is by all three in the following order: last_name, first_name, primary_id. If the query option is used, the result will not sort by primary_id.
source_institution_codexs:stringOptional.The code of the source institution from which the user was linked. Optional
source_user_idxs:stringOptional.The ID of the user in the source institution. Optional.

Body Parameters

None

Output

This method returns a Users object. See doc

Possible Error Codes

CodeMessage
402119General error.
401651Source institution not valid or not part of fulfillment network.
401861Source institution user with given identifier not found.
4019990Local copied user information not found.
60224Organization institution not found.
60225Fulfillment network not found.
60226Fulfillment network copied user not found.