Projects API

The Projects API gives access to TeamHaven's Project Management functionality.

List of projects

GET /api/projects

Enumerates a list of the Projects which the user has access to. Only active projects which have not been archived are returned.

Project details

GET /api/projects/:id

Retrieves the Project with the specified Project ID.

Create new project

POST /api/projects

Request

{
  Name: "My project",
  Description: "This is a demo project",
  Reference: "ABC123",
}

Response

TODO

Get project settings

GET /api/projects/:id

Response

{
  Name: 'My project',
  Description: 'This is a demo project',
  Reference: 'ABC123',

  ContactUserID: 12,

  PreviewMargin: 7,
  CriticalMargin: 3,
  ExpiryMargin: 3,

  CollectorCanUpdateCalls: true,
  CollectorCanCreateCalls: true,

  MobileGroupingAttributeID: 12,
  RetainCompletedCalls: true,
  CheckinsEnabled: true,
  DefaultCountry: 'GB',

  IncludedInPayroll: true
}

Update project settings

PUT /api/projects/:id

Request

As above.

Get project theme

GET /api/projects/:id/theme

Response

{
    AccentBackgroundColor: #0081c6,
    AccentForegroundColor: #ffffff,
    AccentBorderColor: #008186,
    BoxBackgroundColor: #ffffff
}

Set project theme

PUT /api/projects/:id/theme