API Reference
Player Routes
| Resource | Description |
|---|---|
| GET /player | Returns the player profile information |
| GET /players | Returns a listing of all the players in the game |
| POST /players | Create a new player |
| DELETE /players/:playerId | Delete an existing player |
| PUT /players/:playerId/reset | Reset a player's scores |
| GET /activity | Get the player's activity feed |
| GET /approvals | Get the list of pending approvals to join teams/processes for the player |
| GET /invites | Get the list of pending invitations to join teams/processes for the player |
| POST /invites/:inviteId | Accept an invitation to join a process or a team |
| DELETE /invites/:inviteId | Reject an invitation to join a process or a team |
| POST /play | Play an activity which was notified by a trigger email |
Definition Routes
| Resource | Description |
|---|---|
| GET /definitions/processes | Get a list of all available process definitions |
| POST /definitions/processes/:definitionId | Start a process using the process definition |
| GET /definitions/teams | Get a list of all available team definitions |
| POST /definitions/teams/:definitionId | Create a team from the team definition |
Process Routes
| Resource | Description |
|---|---|
| GET /processes | Get a list of all processes the player can play/join |
| GET /processes/:processId | Get the current state information of a process |
| GET /processes/:processId/activity | Get the process activity feed |
| GET /processes/:processId/triggers | Get a list of all available triggers a player can perform in a process |
| POST /processes/:processId/play | Play a process |
| POST /processes/:processId/roles | Join/Leave/Edit roles on a process |
| GET /processes/:processId/approvals | Get a list of player requests to join a process |
| POST /processes/:processId/approvals/:requestId | Accept a player request to join a process |
| DELETE /processes/:processId/approvals/:requestId | Reject a player request to join a process |
| GET /processes/:processId/invites | Get a list of invites the player has sent out to join a processes |
| POST /processes/:processId/invites | Invite a player to join a process |
| DELETE /processes/:processId/invites/:inviteId | Cancel a pending invite sent out by the player |
Team Routes
| Resource | Description |
|---|---|
| GET /teams | Get a list of all the teams the player can play/join |
| GET /teams/:teamId | Get stats for a team |
| GET /teams/:teamId/activity | Get the team activity feed |
| DELETE /teams/:teamId | Disband a team |
| POST /teams/:teamId/roles | Join/Leave/Edit roles on a team |
| PUT /teams/:teamId/lock | Lock a team to prevent new members from joining the team |
| DELETE /teams/:teamId/lock | Remove a lock on a team; allowing new members to join the team |
| GET /teams/:teamId/approvals | Get a list of player requests to join a team |
| POST /teams/:teamId/approvals/:requestId | Accept a player request to join a team |
| DELETE /teams/:teamId/approvals/:requestId | Reject a player request to join a team |
| GET /teams/:teamId/invites | Get a list of invitations the player sent out to join a team |
| POST /teams/:teamId/invites | Invite a player to join a team |
| DELETE /teams/:teamId/invites/:inviteId | Cancel a pending invite sent out by the player |
| GET /teams/:teamId/members | Get a list of all the players who are members of a team |
| GET /teams/:teamId/members/:memberId | Get a team member's profile |
| POST /teams/:teamId/members/:memberId/roles | Assign a team member's roles |
Metric Routes
| Resource | Description |
|---|---|
| GET /metrics | Get a list of all the metrics in the game |
| GET /metrics/:metricId | Get a game-wide leaderboard for a metric |
Asset Routes
| Resource | Description |
|---|---|
| GET /assets/players/:playerId | Get a player image |
| GET /assets/metrics/:metricId | Get a metric/metric state/metric item image. |
| GET /assets/definitions/teams/:teamDefinitionId | Get a team definition image |
| GET /assets/definitions/processes/:processDefinitionId | Get a process definition image |