API Objects

API Status:
API Status:
API Status:
Weekly API Changelog
Want to be notified about changes in the TeamSnap API?
Sign up here to receive our weekly changelog newsletter

API Objects

The TeamSnap API has a large number of objects and concepts that may be unfamiliar. This document describes these objects and some of their roles.

Users

There is only one user related object - the user!

me

The me rel will direct you to the current user's object. It is not possible to create or delete users via the API; however, it is possible to update data on a user's record.

rels that point to user objects are:

Teams

teams

The teams rel will direct you to associated teams from your origin object. Full CRUD is possible with the teams endpoint.

teams_preferences

The teams_preferences rel will direct you to the team preferences for a specific team.

custom_fields

tracked_items

tracked_item_statuses

Members

A member (also referred to as a roster in our web and mobile apps) is a member of a team.

members

The members rel provides a list of members associated with the origin object.

member_email_addresses

The member_email_addresses rel provides a list of email addresses associated with the member record.

member_phone_numbers

The member_phone_numbers rel provides a list of phone numbers associated with the member record.

member_preferences

Contacts

A contact is an associated object to a member; and represents a person who should be a designated contact for the member (i.e. parents, grandparents, emergency contact)

contacts

The contacts rel provides a list of contacts associated with the origin object.

contact_email_addresses

contact_phone_numbers

contact_preferences

Events

An event is an associated object to a team; and represents an event or game that is tracked in the TeamSnap system.

events

locations

opponents

assignments

availabilities