Get Users
Description: To get a list of users, a HTTP GET request is made to the URL with the user ID and session token.
Method: GET
URI: /users/
Headers: Authorization: Third party based authorization header
Returns
Field | Type | Description |
---|---|---|
id | Integer | Unique ID of the user. |
given_name | String | First name of the user. |
surname | String | Last name of the user. |
active | Integer | Returns true if the user is active. |
principal | Boolean | Returns true if user is principal. |
member_number | String | Unique ID of the user's agency. |
created | Timestamp | Returns Unix timestamp of when user was created. |
updated | Timestamp | Returns Unix timestamp of when user was last updated. |
agency_id | Integer | Unique ID of the user's agency. |
Example
Request
Response