Users API

A user is a person who can log into your tripleseat account. Currently we do not allow creating, updating, or deleting users via our API.

Users Fields Overview (JSON | XML schema)

  • first_name (required)
  • last_name (required) 
  • email
  • login_count
  • login_at - last time this user has logged in
  • title - V.P, President, Manager, etc.
  • phone_numbers - Nested collection of phone numbers

User Show / List Endpoints (JSON | XML schema)

GET /v1/users.(xml | json) 

Retrieves a paginated list of users (50 per page, use page parameter to iterate over pages).

GET /v1/users/{id}.(xml | json) 

Retrieves a user by its ID.

GET /v1/users/search.(xml | json)?{search params}

Search for users using filtering parameters (listed below). Append parameters together using & (e.g., ?query=kevin).

Search Parameters and values

  • query - searches by name, email, phone
  • page (1..9999999)
Have more questions? Submit a request

Comments