User

GET /api/1.0/user/{id}

Resources for users.

GET(id)

Return information about the User with the given numeric id.

Name Type Value
id int unique identifier
username string optional user-friendly unique name
first_name string User's real name
middle_name string
last_name string
avatar string absolute HTTP URL for an avatar image
location string free-form text describing the User's location
biography string free-form text describing the User
is_site_admin boolean whether the user is a Parachutes admin
links list absolute HTTP URLs entered by the User
groups list ids for Groups to which the User belongs
works list ids for Works the User has authored
url string absolute HTTP URL for the User

Group

GET /api/1.0/group/{id}

Resources for groups.

GET(id)

Return information about the Group with the given numeric id.

Name Type Value
id int unique identifier
title string user-friendly name
url string absolute HTTP URL for the Group
owner int id of the User who created the Group
category string Group type
banner string absolute HTTP URL for a banner image
description string free-form description of the Group
workshop int id of the Group's Workshop
links list absolute HTTP URLs
works list ids for Works associated with the Group

GroupMembers

GET /api/1.0/group/{id}/members

Resources for group membership.

GET(id)

Return information about members of the Group with the given numeric id.

The return value is a list whose members are in the same format as returned by User resources.

Work

GET /api/1.0/work/{id}

Resources for user-authored content ("works").

GET(id)

Return information about the Work with the given numeric id.

Name Type Value
id int unique identifier
title string Work title
author int id of the User who created the Work
created datetime
comments int number of comments on the Work
url string absolute HTTP URL for the Work

Workshop

GET /api/1.0/workshop/{id}

Resources for the Flash-based workshop.

GET(id)

Return information about the Workshop with the given numeric id.

Name Type Value
id int unique identifier
owner int id of the Group to which the Workshop belongs
rooms list list of Workshop Room objects

A Workshop Room object has the following form:

Name Type Value
title string name of the room
created datetime
admins list ids of Users with admin privileges for the Room