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.
There is only one user related object - the user!
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.
rel
s that point to user
objects are:
me
- this rel
always points to the current userusers
The teams
rel
will direct you to associated teams from your origin object. Full CRUD is possible with the teams endpoint.
The teams_preferences
rel
will direct you to the team preferences for a specific team.
A member
(also referred to as a roster
in our web and mobile apps) is a member of a team.
The members
rel
provides a list of members associated with the origin object.
The member_email_addresses
rel
provides a list of email addresses associated with the member
record.
The member_phone_numbers
rel
provides a list of phone numbers associated with the member
record.
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)
The contacts
rel
provides a list of contacts associated with the origin object.
An event
is an associated object to a team; and represents an event or game that is tracked in the TeamSnap system.