GET/ users

This API returns a collection of users existing within Guardian. This method returns up to 50 users. The ‘links’ section of the response includes paging information. Use this information to obtain additional collections of user records. Results are ordered by fullName and include the user’s Guardian ID which can be used in a subsequent GET request to obtain additional details related to the individual user. For additional parameter information access the users data model section to review field information.

Method

GET

Resource Information

Requires authentication?	YES
Response formats	JSON

Parameters

Parameter	Required	Description
page	No	specifies the page number from where you want to begin accessing records

Filtering

The fields in the table below can be used in the query string of a GET request, for example:

GET https://<server>/v1/employees?firstName=John

Currently, it is only possible to query for exact values (no wildcards or partial matches); however, the query criteria is case-insensitive.

Parameter	Type	Description
emailAddress	string	User’s email address
firstName	string	User’s first name
lastName	string	User’s last name
login	string	User’s system login name
middleName	string	User’s middle name
title	string	User’s title

Example

Request Example
GET https://<server>/v1/users
Response Example

{
 ""searchResult"": [
 {
 ""emailAddress"": ""abc@email.com"",
 ""retired"": false,
 ""firstName"": ""Steve"",
 ""title"": ""Manager"",
 ""lastName"": ""Adam"",
 ""role"": {
 ""name"": ""Location Manager"",
 ""id"": 1281
 },
 ""groups"": [
 {
 ""name"": ""Branch 123-123"",
 ""id"": 110428
 },
 {
 ""name"": ""Branch 322-123"",
 ""id"": 57834
 }
 ],
 ""profileId"": """",
 ""fullName"": ""Adam, Steve"",
 ""id"": 298503
 },
 {
 ""emailAddress"": “mary@email.com”,
 ""retired"": false,
 ""firstName"": ""Mary'"",
 ""title"": ""Director"",
 ""lastName"": ""Benga"",
 ""role"": {
 ""name"": ""Super Admin"",
 ""id"": 1286
 },
 ""groups"": [
 {
 ""name"": ""Branch 123-123"",
 ""id"": 110428
 },
 {
 ""name"": "" Branch 322-123"",
 ""id"": 57834
 },
 {
 ""name"": ""Corp 003"",
 ""id"": 108322
 }
 ],
 ""profileId"": ""3"",
 ""fullName"": ""Benga, Mary'"",
 ""id"": 41744
 },
 {
 ""emailAddress"": ""mark@email.com"",
 ""retired"": true,
 ""firstName"": ""Mark"",
 ""title"": ""Hiring Manager"",
 ""lastName"": ""case"",
 ""role"": {
 ""name"": ""HR Manager"",
 ""id"": 1283
 },
 ""groups"": [],
 ""profileId"": ""534534"",
 ""fullName"": ""Case, Mark"",
 ""id"": 198786
 }
 ],
 ""links"": [
 {
 ""href"": ""/v1/users/"",
 ""rel"": ""self""
 },
 {
 ""href"": ""/v1/users/?page=1"",
 ""rel"": ""first""
 },
 {
 ""href"": ""/v1/users/?page=1"",
 ""rel"": ""last""
 },
 {
 ""href"": ""/v1/users/?page=1"",
 ""rel"": ""next""
 },
 {
 ""href"": ""/v1/users/?page=1"",
 ""rel"": ""previous""
 }
 ]
}

Single Record Request Example

GET https://<server>/v1/users/<user_id>

Single Record Response Example

{
 ""samlId"": null,
 ""retired"": false,
 ""cellExtension"": """",
 ""firstName"": ""Sharon"",
 ""title"": ""Director of HR"",
 ""homeNumber"": null,
 ""lastName"": ""Jones"",
 ""workExtension"": """",
 ""workNumber"": null,
 ""homeExtension"": """",
 ""middleName"": """",
 ""emailAddress"": ""sjones@lawlogix.com"",
 ""cellNumber"": null,
 ""groups"": [
 {
 ""name"": ""Branch 123-123"",
 ""id"": 110428
 },
 ""oauthId"": null,
 ""id"": 46624,
 ""profileId"": ""854124"",
 ""login"": ""xo285k8604"",
 ""role"": {
 ""name"": ""HR Manager"",
 ""id"": 1283
 },
 ""fullName"": ""Jones, Sharon"",
 ""links"": [
 {
 ""href"": ""/v1/users/46624"",
 ""rel"": ""self""
 }
 ]
}