Agency Users

Listing of agency users

get/agency/{agency_id}/user

Query parameters

sFirstNamestring

The user's first name

idstring

A single mongo id

sLastNamestring

The user's last name

sEmailAddressstring

The user's email address

dtCreatedstring date-time

The actual date time for dtCreated

from-dtCreatedstring date-time

The from date time for dtCreated, inclusive

to-dtCreatedstring date-time

The to date time for dtCreated, exclusive

dtModifiedstring date-time

The actual date time for dtModified

from-dtModifiedstring date-time

The from date time for dtModified, inclusive

to-dtModifiedstring date-time

The to date time for dtModified, exclusive

sStatus'active' | 'inactive' | 'awaiting_verification'

The user's status

sUsernamestring

The user name

dDateOfBirthstring date

User's date of birth

pageinteger

The page of documents to be displayed

items_per_pageinteger

The number of documents per page

sortBystring[]

A comma separated list of fields indicating sort order id, dtStart, a negative sign reverses direction -id

sAgencyUserStatusstring

The agency user status

qstring

The q parameter to search on first name, last name and username

Response

Agency users listing

sFirstNamestring required
sLastNamestring required
sEmailAddressstring required
dtCreatedstring date-time required
dtModifiedstring date-time
sStatus'active' | 'inactive' | 'awaiting_verification'
sUsernamestring
idstring required
dDateOfBirthstring date
sAgencyUserStatusstring

Changes

No recorded changes to this endpoint across all 1 revision of this API.