Get Project

Accessible by

• Soulbound administrators
• Organizations

Request

GET {uri:project} HTTP/1.1
Version: 1
Accept: "application/vnd.gg.soulbound.project+json"
Authorization: Bearer <api-key>

Name	Type	Description
api-key	string	The client's API key

On success

HTTP/1.1 200 OK
Content-Type: "application/vnd.gg.soulbound.project+json"

{
  "name": {project-name},
  "organization": {uri:organization},
  "quests": {uri:project-quests},
  "eventTypes":
  [
     {event-type}
  ],
  "number-of-users": {number-of-users},
  "users":
  [
    {user-name}: {uri:user}
  ],
  "top-active-users":
  [
    {user-name}: {uri:user}
  ]
}

Name	Type	Description
project-name	string	The name of the project
uri:organization	string	The URL of the project organization
uri:project-quests	string	The URL of this project's quests
uri:user	string	The URL of the user
user-name	string	The name of a user
number-of-users	number	The number of users actively participating in this project

If the project does not exist

HTTP/1.1 404 Not Found

Permission denied

HTTP/1.1 401 Unauthorized
WWW-Authenticate: Bearer realm="https://api.soulbound.gg/"