User

User

active
boolean or null
created_at
string <date-time>
email
string >= 5 characters ^[A-Z0-9!#$%&'*+/=?^_`{|}~.-]+@[A-Z0-9.-]+\.[...
first_name
string
id
string <int64>
last_name
string
object
new_ui_enabled
boolean or null
Array of objects or null (PhoneNumber)
privacy_policy_accepted
number or null
role
string or null
Enum: "administrator" "bookkeeper" "power receptionist" "practitioner" "receptionist" "scheduler"
time_zone
string
Enum: "Abu Dhabi" "Adelaide" "Alaska" "Almaty" "American Samoa" "Amman" "Amsterdam" "Arizona" "Ashgabat" "Astana" "Asuncion" "Athens" "Atlantic Time (Canada)" "Auckland" "Azores" "Baghdad" "Baku" "Bangkok" "Beijing" "Beirut" "Belgrade" "Berlin" "Bern" "Bogota" "Brasilia" "Bratislava" "Brisbane" "Brussels" "Bucharest" "Budapest" "Buenos Aires" "Cairo" "Canberra" "Cape Verde Is." "Caracas" "Casablanca" "Cayenne" "Central America" "Central Time (US & Canada)" "Chatham Is." "Chennai" "Chihuahua" "Chongqing" "Copenhagen" "Damascus" "Darwin" "Dhaka" "Dublin" "Eastern Time (US & Canada)" "Edinburgh" "Ekaterinburg" "Fiji" "Georgetown" "Greenland" "Guadalajara" "Guam" "Hanoi" "Harare" "Hawaii" "Helsinki" "Hobart" "Hong Kong" "Indiana (East)" "International Date Line West" "Irkutsk" "Islamabad" "Istanbul" "Jakarta" "Jerusalem" "Kabul" "Kaliningrad" "Kamchatka" "Karachi" "Kathmandu" "Kolkata" "Krasnoyarsk" "Kuala Lumpur" "Kuwait" "Kyiv" "La Paz" "Lima" "Lisbon" "Ljubljana" "London" "Lord Howe" "Madrid" "Magadan" "Marshall Is." "Mazatlan" "Melbourne" "Mexico City" "Mid-Atlantic" "Midway Island" "Minsk" "Monrovia" "Monterrey" "Montevideo" "Moscow" "Mountain Time (US & Canada)" "Mumbai" "Muscat" "Nairobi" "New Caledonia" "New Delhi" "Newfoundland" "Novosibirsk" "Nuku'alofa" "Osaka" "Oslo" "Pacific Time (US & Canada)" "Paris" "Perth" "Port Louis" "Port Moresby" "Prague" "Pretoria" "Puerto Rico" "Quito" "Rangoon" "Riga" "Riyadh" "Rome" "Samara" "Samoa" "Santiago" "Sapporo" "Sarajevo" "Saskatchewan" "Seoul" "Singapore" "Skopje" "Sofia" "Solomon Is." "Srednekolymsk" "Sri Jayawardenepura" "St. Petersburg" "Stockholm" "Sydney" "Taipei" "Tallinn" "Tashkent" "Tbilisi" "Tehran" "Tijuana" "Tokelau Is." "Tokyo" "Tripoli" "UTC" "Ulaanbaatar" "Urumqi" "Vienna" "Vilnius" "Vladivostok" "Volgograd" "Warsaw" "Wellington" "West Central Africa" "Windhoek" "Yakutsk" "Yerevan" "Zagreb" "Zurich"
time_zone_identifier
title
string or null
updated_at
string <date-time>
user_active
boolean or null
{
  • "active": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "email": "string",
  • "first_name": "string",
  • "id": "string",
  • "last_name": "string",
  • "new_ui_enabled": true,
  • "phone_numbers": [
    • {
      • "normalized_number": "39012345678",
      • "number": "0-123-456-78",
      • "phone_type": "Fax"
      }
    ],
  • "privacy_policy_accepted": 0,
  • "role": "administrator",
  • "time_zone": "Melbourne",
  • "time_zone_identifier": "Australia/Melbourne",
  • "title": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "user_active": true
}

Get authenticated user

get/user
SecuritybasicAuth
Responses
200

Successful operation

Request samples
Response samples
application/json
{
  • "active": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "email": "string",
  • "first_name": "string",
  • "id": "string",
  • "last_name": "string",
  • "new_ui_enabled": true,
  • "phone_numbers": [
    • {
      • "normalized_number": "39012345678",
      • "number": "0-123-456-78",
      • "phone_type": "Fax"
      }
    ],
  • "privacy_policy_accepted": 0,
  • "role": "administrator",
  • "time_zone": "Melbourne",
  • "time_zone_identifier": "Australia/Melbourne",
  • "title": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "user_active": true
}

List users

get/users
SecuritybasicAuth
Request
query Parameters
order
string
Deprecated
Enum: "asc" "desc"
page
integer
per_page
integer [ 1 .. 100 ]
q[]
Array of strings

Filter result by one or more fields.

See Filtering Results

Available filters:

Value Format
created_at date-time
id int64
updated_at date-time
sort
Array of strings

Comma separated search fields. See: Ordering

Example: sort=created_at:desc
Responses
200

successful operation

Request samples
Response samples
application/json
{}

Get user

get/users/{id}
SecuritybasicAuth
Request
path Parameters
id
required
string <int64>
Responses
200

Successful operation

Request samples
Response samples
application/json
{
  • "active": true,
  • "created_at": "2019-08-24T14:15:22Z",
  • "email": "string",
  • "first_name": "string",
  • "id": "string",
  • "last_name": "string",
  • "new_ui_enabled": true,
  • "phone_numbers": [
    • {
      • "normalized_number": "39012345678",
      • "number": "0-123-456-78",
      • "phone_type": "Fax"
      }
    ],
  • "privacy_policy_accepted": 0,
  • "role": "administrator",
  • "time_zone": "Melbourne",
  • "time_zone_identifier": "Australia/Melbourne",
  • "title": "string",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "user_active": true
}