Projects API Documentation

List Projects

GET /api/v1/accounts/:account_id/projects

Returns a paginated list of projects for the authenticated account.

Query Parameters

status - Filter by status
project_status - Filter by project status
assigned_to - Filter by assignee
project_tag_list - Filter by project tags
page - To paginate through results (10 per page)

Response

Returns an array of project objects with the following properties:

[
  {
    "id": integer,
    "name": string,
    "description": string,
    "project_status_id": integer,
    "company_id": integer,
    "start_date": date,
    "end_date": date,
    "total_budget_cents": integer,
    "currency": string
  }
]

Get Single Project

GET /api/v1/accounts/:account_id/projects/:id

Returns details for a specific project.

Response

{
  "id": integer,
  "name": string,
  "description": string,
  "project_status_id": integer,
  "company_id": integer,
  "start_date": date,
  "end_date": date,
  "total_budget_cents": integer,
  "currency": string
}

Error Responses

404 Not Found - Project not found or not accessible by current account

The API requires authentication and will only return projects belonging to the authenticated account's scope. Refer to the documentation on Drum's API authentication requirements.

Dynamic Document Generation Reference

Planned Invoices API Documentation

Drum API Authentication

Accounts API