API Documentation

Current Version Number: 4

Methods

Comment Detail

Retreive a specific comment.
GET /api/{version}/comment/{commentID}.json
commentID integer required

Track Comments

Retrieve comments for a track
GET /api/{version}/track/{trackID}/comments.json
trackID integer required

Track New Comment

Post a new comment
GET /api/{version}/track/{trackID}/comments/{commentID}/edit.json
GET /api/{version}/track/{trackID}/comments/new.json
trackID integer required
content string required
attachmentIDs integer[] optional
commentID integer optional optional; ID of comment to be edited
Search Groups
GET /api/{version}/groups.json
keywords string optional
onlyMine boolean optional
relatedToGroupID integer optional
relatedToUserID integer optional
latitude double optional
longitude double optional
distance double optional
minRole GroupRoles optional
page integer optional
count integer optional
sort ProfileSorts optional

User Groups

Retreive groups's followers.
GET /api/{version}/group/{userID}/users.json
GET /api/{version}/group/{vanity}/users.json
groupID integer required
vanity string required

Group Groups

Retreive group's related groups.
GET /api/{version}/group/{userID}/groups.json
GET /api/{version}/group/{vanity}/groups.json
groupID integer required
vanity string required

Group Detail

Retreive group information
GET /api/{version}/group.json
GET /api/{version}/group/{vanity}.json
GET /api/{version}/group/{groupID}.json
groupID integer required
vanity string required

Group Form Detail (Anonymous via group form key)

Retreive group form information for anonymous requests via a Group Form key
GET /api/{version}/group/form/{key}.json
key Guid required

Edit Group

POST /api/{version}/group/{path_vanity}.json
POST /api/{version}/group/{groupID}.json
POST /api/{version}/group/new.json
groupID integer optional
path_vanity string optional
name string optional
bio string optional
vanity string optional
email string optional
location string optional
phone string optional
url string optional
latitude double optional
longitude double optional
icon string optional Base-64 encoded binary image data in JPEG or PNG format.
type GroupTypes optional
deleted boolean optional
private boolean optional

User Detail

Retreive user information.
GET /api/{version}/user/{userID}.json
GET /api/{version}/user.json
GET /api/{version}/user/{vanity}.json
userID integer optional
vanity string optional
identifier string optional

User Groups

Retreive user's groups.
GET /api/{version}/user/{userID}/groups.json
GET /api/{version}/user/{vanity}/groups.json
userID integer required
vanity string required
Search Users
GET /api/{version}/users.json
keywords string optional
onlyMine boolean optional
latitude double optional
longitude double optional
distance double optional
followingUserID integer optional
relatedToUserID integer optional
followingGroupID integer optional
membersOfGroupID integer optional
minRole GroupRoles optional
page integer optional
count integer optional
sort ProfileSorts optional

User Users

Retreive user's followers.
GET /api/{version}/user/{userID}/users.json
GET /api/{version}/user/{vanity}/users.json
userID integer required
vanity string required

Edit Current User

POST /api/{version}/user.json
firstName string optional
lastName string optional
bio string optional
vanity string optional
email string optional
location string optional
phone string optional
url string optional
latitude double optional
longitude double optional
icon string optional Base-64 encoded binary image data in JPEG or PNG format.
deleted boolean optional
private boolean optional

Track Detail

Retrieve detailed information for a track.
GET /api/{version}/track/{trackID}.json
trackID integer required

Track Subtracks

Retrieve subtracks for a track
GET /api/{version}/track/{trackID}/subtracks.json
trackID integer required
count integer optional
page integer optional

Track Attachments

Retrieve attachments for a track.
GET /api/{version}/track/{trackID}/attachments.json
trackID integer required

Track Attachments

Retrieve a specific attachment for a track.
GET /api/{version}/track/{trackID}/attachment/{attachmentID}.json
trackID integer required
attachmentID integer required
latest boolean optional retreive the most recent version

Track User Add

Add a user or group to a track
GET /api/{version}/track/{trackID}/{type}/{id}/add.json
track Track required
type string required user or group
id integer required

Track User Add

Add a user or group to a track
GET /api/{version}/track/{trackID}/add.json
track Track required
userIDs integer[] required
groupIDs integer[] required
viewModes integer optional

Track User Remove

Remove user or group from track
GET /api/{version}/track/{trackID}/{type}/{id}/remove.json
trackID integer required
type string required user or group
id integer required

Track User Update

Update a track user
GET /api/{version}/track/{trackID}/user.json
track Track required
userID integer required
isLead boolean optional
isComplete boolean optional
hoursWorkedAll decimal optional
hoursRemaining decimal optional

Modify Track

Make edits to an existing track or create a new one.
GET /api/{version}/track/new.json
GET /api/{version}/track/{trackID}.json
GET /api/{version}/track.json
trackID integer optional
trackIDs integer[] optional For editing multiple tracks at once, specify a comma-separated list of ID's
delete boolean optional
removed boolean optional
important boolean optional
trackComplete boolean optional
userComplete boolean optional
complete boolean optional sets trackComplete when the user is the creator of or leader for the track
following boolean optional
isPinned boolean optional
tracksetID integer optional
parentTrackID integer optional
dateDue DateTime optional
dateStart DateTime optional
mergeTrackID integer optional
categories string[] optional
groupID integer optional
groupName string optional
content string optional
moreImportantThan integer optional
lessImportantThan integer optional
privacy TrackPrivacy optional
isMilestone boolean optional
vote boolean optional

Types

TrackPrivacy

Private Secret Public