Skip to main content

API | Overview

Mark Lawrence
Updated

API | Overview

This article aims to serve as an overview of Tripleseat’s API Endpoints in addition to some standard information regarding general API best practices. Before navigating to a specific Endpoint, you will want to review our Authentication Article below to ensure that you can get authenticated via OAuth.

API | Authentication

Best Practices:

Common Status Codes:

  • 200 OK - Standard response for successful requests
  • 400 Bad Request - This means that client-side input fails validation.
  • 401 Unauthorized - This means the user is not authorized to access a resource. It usually returns when the user isn't authenticated.
  • 403 Forbidden - This means the user is authenticated, but it's not allowed to access a resource.
  • 404 Not Found - This indicates that a resource is not found.
  • 500 Internal server error - This is a generic server error.

The above Status Codes and brief explanations provide a great place to start the troubleshooting process. An example of this would be when attempting to perform a GET to an Endpoint and receiving a “401 Unauthorized.” Bearing the definition above in mind, you may want to begin troubleshooting how you are authorizing your requests.

 

Data Representation:

Throughout our documentation, you will often see us referencing “.(XML | JSON)” This is to differentiate between how you would like the response body to be formatted. That being said, the documentation will use JSON in its examples; however, it is worth noting that you can use the “.(XML | JSON)” suffix to your call to your preference and are not restricted to only JSON.

  • .xml
  • .json

Request Types:

Below are the most commonly referenced Request Types you will find within our documentation and a brief description of the request.

Request Type Description
GET To pull or “get” data from the specified URL with the addition of any parameters included in the request.
POST To send or “post” a new record to the specified URL. This request is most commonly used in conjunction with the API | Leads Endpoint to submit new Leads via the API.
DELETE To delete an existing record specified in the URL of the request.
PUT To update a portion of an existing record specified in the URL of the request.

 

Public Collection:

The API | Public Collection article provides a download link for a JSON Showcase File of the Tripleseat API. This article should be considered supplemental to the other Knowledge Base Articles outlined in the following section. As updates are made to the Tripleseat API, this file will be updated accordingly.

This file should help serve as a quick way to set up a Test Environment in programs such as Postman where most of our examples and screenshots are from.

 

API Endpoints:

All of our endpoints begin with a base URL of: 

https://api.tripleseat.com/

Below are links to other articles within this section of the Knowledge Base:

Should you and your team have specific questions regarding the API, please feel free to reach out to support@tripleseat.com