Skip to main content

API | Users Endpoint

Mark Lawrence
Updated

A user is a person who can log into your Tripleseat. Currently, we do not allow creating, updating, or deleting users via our API. For assistance with creating, updating, or deleting a User, please reach out to an Admin on your account. Should they have questions or need assistance they are welcome to reach out to support@tripleseat.com 

Users Fields Overview

Below you will find a comprehensive list of the fields within the Users Endpoint. The order displayed below is representative of the order in which they are displayed within a response body of a standard GET request.

Field Name Description Response Example - Key | Value
“id” The ID Number for the User. “Id”: (Numerics),
“first_name” The First Name of the User. “first_name”: “(Alphanumerics)”,
“last_name” The Last Name of the User. “last_name”: “(Alphanumerics)”,
“title” The Title of the User. “title”: “(Alphanumerics)”,
“email” The Email Address of the User. “email”: “(Alphanumerics)”,
“created_at” The Date and Timestamp for when the User was Created. “created_at”: “MM/DD/YYYY HH:MM AM/PM”,
“updated_at” The Date and Timestamp for when the User was last Updated. “updated_at”: “MM/DD/YYYY HH:MM AM/PM”,
“login_count” The collective amount of times the User logged in. “login_count”: “(Numerics)”,
“login_at” The Date and Timestamp for when the User last logged in. “login_at”: “MM/DD/YYYY HH:MM AM/PM”,
“customer_id” The ID number for the Customer that the User belongs to.

*For additional clarity, the Customer is a collection of all Sites and their associated Locations. Customer -> Site(s) -> Location(s)		 “customer_id”: “(Numerics)”,
“phone_numbers” | Array An array or “collection” of assorted fields specific to the Phone Number(s) for the User.

“phone_numbers”: [ 

{

“id”: (Numerics),

“number: “(Alphanumerics)”,

“phone_number_type”: “(Main/Mobile/Fax/Work/Home/Pager/Skype)”,

“extension”: “(Alphanumerics)”

},
{ … }
]

Request Examples:

As mentioned at the beginning of this article, we do not allow for creating, updating, or deleting via the Users API; however, you are able to pull this information via a GET request, as shown below:

GET https://api.tripleseat.com/v1/users.(XML | JSON)

This request will pull a paginated list of all Users.

 

GET https://api.tripleseat.com/v1/users/(User_ID).(XML | JSON )

This request will pull User information specific to the ID specified in the request URL.

GET https://api.tripleseat.com/v1/users/search.(XML | JSON)?query=(Search_Parameters)

This request will pull User information for any records that match the queried parameters. When you query multiple parameters, you can append parameters together using a “&”

Parameter Value
query First/Last Name, Email Address, Phone Number

 

Pro-Tip

GET https://api.tripleseat.com/v1/users/user_audit_report.csv
 

This request will produce a CSV file of all Active/Suspended Users with the following headers and information:

  • user_id
  • login
  • first_name
  • last_name
  • email
  • user_state
  • site_id
  • site
  • location_id
  • location
  • site_role
  • location_role
  • last_login_at

 

If using a program such as Postman, you have the option to “Send and Download,” which will download the CSV file to your device.