API Overview & Resources

The Tripleseat Public API lets you connect Tripleseat to other tools and build your own integrations. This article shows you where to find the API documentation, how to pull the spec into the tools you already use, and what you need to make API calls.

The interactive documentation

The easiest way to explore the API is the built-in documentation inside Tripleseat:

• Log in to your Tripleseat account.
• Go to Settings > API.
• Open the Documentation tab.
• From here you can browse every endpoint, see example requests and responses, and try calls directly in your browser. This is the best starting point if you want to understand what the API can do.

The Spec URL (for developers and tools)

If you work with a developer or use API tooling, Tripleseat publishes the full OpenAPI specification at a stable, public URL:

• https://api.tripleseat.com/api-docs/v1/openapi.yaml

No login is required to view the spec, and it always reflects the current released version of the API, so there is nothing to re-download when we make updates.

You can use this URL to:

• Import the API into Postman (File > Import, then paste the URL).
• Load it into Stoplight, Insomnia, or any other OpenAPI viewer.
• Generate a client library with tools like openapi-generator or swagger-codegen.

What you need to make API calls

Viewing the documentation and the spec is open to everyone. Making actual API calls requires credentials:

• Most endpoints use an OAuth 2.0 access token.
• Lead forms and location endpoints can use a public key.
• You will find your credentials and setup steps under Settings > API in your Tripleseat account. The interactive documentation describes which method each endpoint uses.

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.
• 410 OAuth 1.0 authentication is no longer supported - This means the call used the depreciated OAuth 1.0 Authentication method, and must migrate to OAuth 2.0. (Migration Guide)
• 422 Unprocessable Content - indicates that the server understood the content type of the request content/syntax but it was unable to process the contained instructions.
• 429 Too many requests. Please wait and try again. - Means that your have exceeded our Rate Limits
• 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.

Rate Limits:

• 10 requests per second
• 18,000 requests per hour
• 1,200 requests per minute

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.

Questions

If you need help with API access or credentials, contact Tripleseat Support and we will point you in the right direction.