Users

4 min read

GET Methods #

Get All Users #

Description

Loads all users. The results may be limited by privacy settings.

Query String Parameters
Name	Description
username	Username to filter by.
email	Email address to filter by.
firstName	First name of users to filter by.
lastName	Last name of users to filter by.
phone	Phone number of users to filter by.
organization	Organization name of users to filter by.
att#	Custom attribute user to filter by. The query string parameter has to be in the format att#=value where # is the attribute Id number.

Route

/Users/

Authentication

This service is secure and requires authentication headers

Example Response

{
 "users": [
 {
 "id": 1,
 "userName": "username",
 "firstName": "first",
 "lastName": "last",
 "emailAddress": "email@address.com",
 "phoneNumber": "123-456-7890",
 "phoneCountryCode": "US",
 "dateCreated": "2023-01-21T08:00:20-0500",
 "lastLogin": "2023-01-21T08:00:20-0500",
 "statusId": "statusId",
 "timezone": "timezone",
 "organization": "organization",
 "position": "position",
 "language": "language_code",
 "customAttributes": [
 {
 "id": 123,
 "label": "label",
 "value": "value",
 "links": [],
 "message": null
 }
 ],
 "currentCredits": "2.50",
 "reservationColor": "#000000",
 "links": [],
 "message": null
 }
 ],
 "links": [],
 "message": null
}

Get User #

Description

Loads a specific user by Id.

Route

/Users/:userId

Authentication

This service is secure and requires authentication headers

Example Response

{
 "id": 1,
 "userName": "username",
 "firstName": "first",
 "lastName": "last",
 "emailAddress": "email@address.com",
 "phoneNumber": "123-456-7890",
 "phoneCountryCode": "US",
 "lastLogin": "2023-01-21T08:00:20-0500",
 "statusId": "statusId",
 "timezone": "timezone",
 "organization": "organization",
 "position": "position",
 "language": "language_code",
 "icsUrl": "webcal:\/\/url\/to\/calendar",
 "defaultScheduleId": 1,
 "currentCredits": "2.50",
 "reservationColor": "#000000",
 "customAttributes": [
 {
 "id": 123,
 "label": "label",
 "value": "value",
 "links": [],
 "message": null
 }
 ],
 "permissions": [
 {
 "id": 123,
 "name": "resource name",
 "type": null,
 "groups": null,
 "links": [],
 "message": null
 }
 ],
 "groups": [
 {
 "id": 1,
 "name": "group name",
 "isDefault": null,
 "roleIds": null,
 "links": [],
 "message": null
 }
 ],
 "links": [],
 "message": null
}

Get Languages #

Description

List all supported languages.

Route

/Users/Languages

Authentication

This service is secure and requires authentication headers

Example Response

{
 "languages": [
 {
 "code": "ar",
 "name": "\u0639\u0631\u0628\u0649"
 },
 {
 "code": "eu_es",
 "name": "Basque"
 },
 {
 "code": "bg_bg",
 "name": "Bulgarian"
 },
 {
 "code": "ca",
 "name": "Catalan"
 },
 {
 "code": "cz",
 "name": "Czech"
 },
 {
 "code": "da_da",
 "name": "Danish"
 },
 {
 "code": "de_de",
 "name": "Deutsch"
 },
 {
 "code": "du_be",
 "name": "Flemisch"
 },
 {
 "code": "du_nl",
 "name": "Dutch"
 },
 {
 "code": "en_us",
 "name": "English US"
 },
 {
 "code": "en_gb",
 "name": "English GB"
 },
 {
 "code": "es",
 "name": "Español"
 },
 {
 "code": "ee_ee",
 "name": "Estonian"
 },
 {
 "code": "fi_fi",
 "name": "Suomi"
 },
 {
 "code": "fr_fr",
 "name": "Français"
 },
 {
 "code": "hr_hr",
 "name": "Hrvatski"
 },
 {
 "code": "hu_hu",
 "name": "Hungarian"
 },
 {
 "code": "he",
 "name": "\u05e2\u05d1\u05e8\u05d9\u05ea"
 },
 {
 "code": "id_id",
 "name": "Bahasa Indonesia"
 },
 {
 "code": "it_it",
 "name": "Italiano"
 },
 {
 "code": "ja_jp",
 "name": "Japanese"
 },
 {
 "code": "lt",
 "name": "Lietuvi\u0173"
 },
 {
 "code": "no_no",
 "name": "Norsk bokm\u00e5l"
 },
 {
 "code": "pl",
 "name": "Polski"
 },
 {
 "code": "pt_pt",
 "name": "Português"
 },
 {
 "code": "pt_br",
 "name": "Português Brasileiro"
 },
 {
 "code": "ru_ru",
 "name": "\u0420\u0443\u0441\u0441\u043a\u0438\u0439"
 },
 {
 "code": "si_si",
 "name": "Sloven\u0161\u010dina"
 },
 {
 "code": "sr_sr",
 "name": "Serbian"
 },
 {
 "code": "ro_ro",
 "name": "Romanian"
 },
 {
 "code": "th_th",
 "name": "Thai"
 },
 {
 "code": "tr_tr",
 "name": "T\u00fcrk\u00e7e"
 },
 {
 "code": "sv_sv",
 "name": "Swedish"
 },
 {
 "code": "vn_vn",
 "name": "Ti\u1ebfng Vi\u1ec7t"
 },
 {
 "code": "zh_cn",
 "name": "\u7b80\u4f53\u4e2d\u6587"
 },
 {
 "code": "zh_tw",
 "name": "\u7e41\u9ad4\u4e2d\u6587"
 }
 ],
 "links": [],
 "message": null
}

Phone Country Codes #

Description

List all supported phone country codes.

Route

/Users/PhoneCountryCodes

Authentication

This service is secure and requires authentication headers

Example Response

{
 "codes": [
 {
 "code": "US",
 "name": "United States",
 "prefix": "1"
 },
 {
 "code": "GB",
 "name": "United Kingdom",
 "prefix": "44"
 },
 {
 "code": "AT",
 "name": "Austria",
 "prefix": "43"
 },
 {
 "code": "BE",
 "name": "Belgium",
 "prefix": "32"
 },
 {
 "code": "BR",
 "name": "Brazil",
 "prefix": "55"
 },
 {
 "code": "CA",
 "name": "Canada",
 "prefix": "1"
 },
 {
 "code": "CL",
 "name": "Chile",
 "prefix": "56"
 },
 {
 "code": "CN",
 "name": "China",
 "prefix": "86"
 },
 {
 "code": "DK",
 "name": "Denmark",
 "prefix": "45"
 },
 {
 "code": "FI",
 "name": "Finland",
 "prefix": "358"
 },
 {
 "code": "FR",
 "name": "France",
 "prefix": "33"
 },
 {
 "code": "DE",
 "name": "Germany",
 "prefix": "49"
 },
 {
 "code": "GR",
 "name": "Greece",
 "prefix": "30"
 },
 {
 "code": "HK",
 "name": "Hong Kong",
 "prefix": "852"
 },
 {
 "code": "IS",
 "name": "Iceland",
 "prefix": "354"
 },
 {
 "code": "IN",
 "name": "India",
 "prefix": "91"
 },
 {
 "code": "ID",
 "name": "Indonesia",
 "prefix": "62"
 },
 {
 "code": "IE",
 "name": "Ireland",
 "prefix": "353"
 },
 {
 "code": "IT",
 "name": "Italy",
 "prefix": "39"
 },
 {
 "code": "IL",
 "name": "Israel",
 "prefix": "972"
 },
 {
 "code": "JP",
 "name": "Japan",
 "prefix": "81"
 },
 {
 "code": "NL",
 "name": "Netherlands",
 "prefix": "31"
 },
 {
 "code": "NO",
 "name": "Norway",
 "prefix": "47"
 },
 {
 "code": "MX",
 "name": "Mexico",
 "prefix": "52"
 },
 {
 "code": "PK",
 "name": "Pakistan",
 "prefix": "92"
 },
 {
 "code": "PH",
 "name": "Philippines",
 "prefix": "63"
 },
 {
 "code": "PL",
 "name": "Poland",
 "prefix": "48"
 },
 {
 "code": "PT",
 "name": "Portugal",
 "prefix": "351"
 },
 {
 "code": "PR",
 "name": "Puerto Rico",
 "prefix": "1787"
 },
 {
 "code": "RO",
 "name": "Romania",
 "prefix": "40"
 },
 {
 "code": "SG",
 "name": "Singapore",
 "prefix": "65"
 },
 {
 "code": "SE",
 "name": "Sweden",
 "prefix": "46"
 },
 {
 "code": "CH",
 "name": "Switzerland",
 "prefix": "41"
 },
 {
 "code": "TH",
 "name": "Thailand",
 "prefix": "66"
 },
 {
 "code": "UA",
 "name": "Ukraine",
 "prefix": "380"
 },
 {
 "code": "",
 "name": "Other\/Not Listed",
 "prefix": ""
 }
 ],
 "links": [],
 "message": null
}

POST Methods #

Create User #

Description

Creates a new user.

Route

/Users/

Authentication

This service is secure and requires authentication headers

This service is only available to application administrators

Example Request

{
 "password": "plain text password",
 "firstName": "first",
 "lastName": "last",
 "emailAddress": "email@address.com",
 "userName": "username",
 "timezone": "America\/Chicago",
 "phone": "123-456-7980",
 "phoneCountryCode": "US",
 "organization": "organization",
 "position": "position",
 "customAttributes": [
 {
 "attributeId": 99,
 "attributeValue": "attribute value"
 }
 ],
 "groups": [
 1,
 2,
 4
 ],
 "reservationColor": null,
 "language": "en_us"
}

Example Response

{
 "userId": 1,
 "links": [
 {
 "href": "http:\/\/url\/to\/user",
 "title": "get_user"
 },
 {
 "href": "http:\/\/url\/to\/update\/user",
 "title": "update_user"
 }
 ],
 "message": null
}

Update User #

Description

Updates an existing user.

Route

/Users/:userId

Authentication

This service is secure and requires authentication headers

This service is only available to application administrators

Example Request

{
 "firstName": "first",
 "lastName": "last",
 "emailAddress": "email@address.com",
 "userName": "username",
 "timezone": "America\/Chicago",
 "phone": "123-456-7989",
 "phoneCountryCode": "US",
 "organization": "organization",
 "position": "position",
 "customAttributes": [
 {
 "attributeId": 99,
 "attributeValue": "attribute value"
 }
 ],
 "groups": [
 1,
 2,
 4
 ],
 "reservationColor": null,
 "language": "en_us"
}

Example Response

{
 "userId": null,
 "links": [
 {
 "href": "http:\/\/url\/to\/user",
 "title": "get_user"
 },
 {
 "href": "http:\/\/url\/to\/update\/user",
 "title": "update_user"
 }
 ],
 "message": null
}

Update User Status #

Description

Updates the status of an existing user. Options are 1 (Active) or 3 (Inactive).

Route

/Users/:userId/Status

Authentication

This service is secure and requires authentication headers

This service is only available to application administrators

Example Request

{
 "statusId": 1
}

Example Response

{
 "userId": null,
 "links": [
 {
 "href": "http:\/\/url\/to\/user",
 "title": "get_user"
 },
 {
 "href": "http:\/\/url\/to\/update\/user",
 "title": "update_user"
 }
 ],
 "message": null
}

Update Password #

Description

Updates the password for an existing user.

Route

/Users/:userId/Password

Authentication

This service is secure and requires authentication headers

This service is only available to application administrators

Example Request

{
 "password": "plaintext password"
}

Example Response

{
 "userId": null,
 "links": [
 {
 "href": "http:\/\/url\/to\/user",
 "title": "get_user"
 },
 {
 "href": "http:\/\/url\/to\/update\/user",
 "title": "update_user"
 }
 ],
 "message": null
}

DELETE Methods #

Delete User #

Description

Deletes an existing user.

Route

/Users/:userId

Authentication

This service is secure and requires authentication headers

This service is only available to application administrators

Example Request

No request body

Example Response

{
 "links": [],
 "message": "The item was deleted"
}/code>

`How was this article?`

Updated on January 21, 2023

Schedules

Getting Started

Guides

Usage

Administration

Installation

Configuration

API

Single Sign On

Additional Support

Users

GET Methods #

Get All Users #

Get User #

Get Languages #

Phone Country Codes #

POST Methods #

Create User #

Update User #

Update User Status #

Update Password #

DELETE Methods #

Delete User #

`How was this article?`

GET Methods #

Get All Users #

Get User #

Get Languages #

Phone Country Codes #

POST Methods #

Create User #

Update User #

Update User Status #

Update Password #

DELETE Methods #

Delete User #

How was this article?

Share This Article :

`How was this article?`

`Share This Article :`