🔵GET users

Fetches a list of users in the organisation.

URL

GET https://training.tapintosafety.com.au/api/v2/users

Parameters

Schema

Query Parameters

Name	Type	Description
page	integer	The page of results to select. Defaults to the first page. 50 results are returned per page.

Example

curl https://training.tapintosafety.com.au/api/v2/users \
    -G -d "page=1"                                      \
    -H "Authorization: Bearer $APIKey"

Responses

200 - OK

A list of users from the database.

Schema

Name	Type	Description
entities	array	The list of the results returned.
┃ id	string	The Id of the user. Formatted as a GUID.
┃ email	string	The users email address.
┃ firstName	string	The users first name.
┃ lastName	string	The users last name.
┃ birthYear	integer	The users birth year. -1 if unspecified.
┃ gender	string	The selected gender of the user.
┃ role	string	The access level of the user for the organisation.
┃ organisationIdentifier	string	The custom identifier set by the organisation.
┃ hasAccess	boolean	Specifies if the user is currently allowed to access the organisations training.
┃ usingSeat	boolean	Whether the user currently using an unlimited use seat. False if the organisation is not on an unlimited use plan.
┃ accountType	string	Specifies the method used to create the user account.
┃ deletionStatus	string	Specifies whether the user account can be deleted, or the reason it cannot be.
┗ userFilters	string[]	A list of the filter answers the user currently has applied.
page	integer	The current page of results (Starts at 1).
entitiesReturned	integer	The number of courses in the entities array.
totalEntities	integer	The total entities across all pages for the current parameters.
links	array	A list of links relevant to the current request. No links are currently returned with this request.
┃ type	string	The type of the given link (e.g. Next Page, Previous Page).
┃ href	string	The URL to call for the given link.
┗ method	string	The HTTP method to use for the link (e.g. GET, POST).

Example

{
  "entities": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "email": "[e-mail]",
      "firstName": "Alice",
      "lastName": "Smith",
      "birthYear": 1980,
      "gender": "UNDISCLOSED",
      "role": "USER",
      "organisationIdentifier": "Employee#1282",
      "hasAccess": true,
      "usingSeat": true,
      "accountType": "API_CREATED",
      "deletionStatus": "SEAT_IN_USE",
      "userFilters": [
        "00000000-0000-0000-0000-000000000000"
      ]
    }
  ],
  "page": 1,
  "entitiesReturned": 1,
  "totalEntities": 2,
  "links": [
    {
      "type": "Next Page",
      "href": "https://training.tapintosafety.com.au/api/v2/users?page=2",
      "method": "GET"
    }
  ]
}