Overview

This document describes the resources that make up the TeamSnap API.

Getting Started

Location

All API access is over HTTPS, and available via https://api.teamsnap.com/v3/. It is highly recommended that you enforce certificate validation to ensure the security of your services and your users.

Schema

TeamSnap's API is a Collection+JSON API. This differs from your normal RESTful style JSON API in a few very important ways:

1. The client should not construct any URIs.
2. Caching of URIs is permitted; however, if an error is encountered, this cache should be cleared.
3. Every JSON object returned will be a collection.

More information on how Collection+JSON works and how it applies to this API is available on the Collection+JSON page of this documentation.

Response Codes

The most common response codes will be in the 200 and 400 ranges.

Successful Calls:

• 200 OK Call completed successfully.
• 201 CREATED Object created successfully.
• 204 NO RESPONSE Call completed, no response required.

Unsuccessful Calls:

• 401 UNAUTHORIZED You are not authorized to access this resource. Try re-authorizing.
• 404 NOT FOUND This resource does not exist, or you may be unauthorized. Try re-authorizing; if that fails, clear your URI cache.
• 411 Length Required You need to add a Content Length header to your request.
• 429 TOO MANY REQUESTS You have reached your rate limit.
• 500 Server took a brief vacation.

Date and Time

All dates and times (including timestamps) are in ISO 8601 Format.

Null Data

Blank fields are sent as null instead of being omitted from responses.

Versioning

The TeamSnap API versioning scheme adheres to the guidelines set out in SemVer 2.0.0. The version of the API is available in each request under the version field. Version is global across the API, resources are not versioned individually.

Constructing a Request

To construct a request, you will need to obtain an authorization token.