API Docs

Retrieve users

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

GET /almaws/v1/users

None

Parameter	Type	Required	Description
`limit`	xs:int	Optional. Default: 10	Limits the number of results. Optional. Valid values are 0-100. Default value: 10.
`offset`	xs:int	Optional. Default: 0	Offset of the results returned. Optional. Default value: 0, which means that the first results will be returned.
`q`	xs:string	Optional.	Search query. Optional. Searching for words from: primary_id, first_name, last_name, middle_name, email, phone_number, job_category, identifiers, birth_date, general_info (keywords from all fields except emails, birth_date and identifiers) and ALL (words from all fields but without support for the AND operator). Example (note the tilde between the code and text): q=last_name~Smith (see Brief Search)
`order_by`	xs:string	Optional. Default: last_name, first_name, primary_id	A 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_code`	xs:string	Optional.	The code of the source institution from which the user was linked. Optional
`source_user_id`	xs:string	Optional.	The ID of the user in the source institution. Optional.

None

This method returns a Users object. See doc

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