Skip to main content

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

FieldTypeDescription
idIntegerUnique ID of the user.
given_nameStringFirst name of the user.
surnameStringLast name of the user.
activeIntegerReturns true if the user is active.
principalBooleanReturns true if user is principal.
member_numberStringUnique ID of the user's agency.
createdTimestampReturns Unix timestamp of when user was created.
updatedTimestampReturns Unix timestamp of when user was last updated.
agency_idIntegerUnique ID of the user's agency.

Example

Request
curl https://app-api.reiformslive.com.au/users \
--request GET \
--header "Authorization: Basic YTlkOWIwYItNGY4Yi1hYTQxLTI5NzZmMTcyZmEyMQ==" \
Response
[
{
"id": 1,
"given_name": "John",
"surname": "Doe",
"active": true,
"principal": false,
"member_number": "123456",
"created": 1347434606,
"updated": 1347434606,
"agency_id": 1
}, ...
]