Agency User

Get a list of users that are linked(with a status of enabled) to any of the agencies for the given agency group

get/agency-group/{agency_group_id}/agency-user

Request

  • Base URL
    http://localhost:3010/v1
  • URL
    http://localhost:3010/v1/agency-group/{agency_group_id}/agency-user
  • Auth
    HTTP basic and HTTP basic

Query parameters

pageinteger

The page of documents to be displayed

items_per_pageinteger

The number of documents per page

active_agency_usersboolean

Show only active agency users. If false, then inactive users will be returned

sortBystring[]

The field to sort by together with sorting order example first_name, -first_name

Headers

Authorizationstring string required

OAuth Bearer token

Contextstring string required

The executing context

Accept'application/json' required

Advertises which content types the client understands

X-Accept-Timezonestring

The timezone the content will be displayed in

Response

List of agency group agency users

_idstring required
first_namestring required
last_namestring required
full_namestring required
user_statusstring required
estimated_inactive_atstring date-time

Changes

No recorded changes to this operation across all 3 revisions of this API.