v2

latestSwagger 2.02026-08-04108164321.0 KB
Project

Retrieves a paginated list of projects with details including status, billing type, budget, category, and date range. Supports filtering by company, category, owner, status, billable type, budget type, and creation date.

get/api/Project

Query parameters

UpdatedAfterstring date-time

Only return projects updated after this UTC date-time (ISO 8601).

pageSizeinteger

Number of items per page (max 1000)

pageNumberinteger

Page to display. Starts from 1.

Sortstring

A column to sort on. Current possible values: "DateUpdated", "DateCreated", "DateUpdated desc", "DateCreated desc"

TimesheetUserIDinteger

Filter to the projects that the supplied UserID can add timesheets to.

CompanyIDinteger

Filter projects belonging to a specific customer company by Company ID.

ProjectCategoryIDinteger

Filter projects by project category ID.

ProjectOwnerUserIDinteger

Filter projects owned by a specific user by User ID.

ProjectStatusCodestring

Filter by project status code. Per-account configurable; default codes are NotStarted, InProgress, Complete, OnHold (seeded for every account); admins may add custom codes.

ProjectBillableTypeCodestring

Filter by billing type. Values: CategoryHourly, NoRate, NotBillable, PersonHourly, ProjectHourly.

ProjectBudgetTypeCodestring

Filter by budget type. Values: CategoryHours, NoBudget, PersonHours, ProjectFees, ProjectHours.

DateCreatedFromstring date-time

Filter projects created on or after this date (ISO 8601).

DateCreatedTostring date-time

Filter projects created on or before this date (ISO 8601).

includeArchivedboolean

Include Archived Projects in the results.

Tagsstring[]

Filter to projects assigned the supplied tag name(s). Repeat the parameter for multiple tags (e.g. ?Tags=Urgent&Tags=Retainer). Names are matched case-insensitively; a name not in the account simply matches nothing. By default a project matches if it has ANY of the supplied tags (see TagMatchMode).

TagMatchModestring

How multiple Tags combine. "any" (default) returns projects with at least one of the supplied tags; "all" returns only projects that have every supplied tag.

Response

Returns a paginated list of projects with details.

TotalCountinteger

Total number of projects matching the query.

PageNumberinteger

Current page number (1-based).

PageSizeinteger

Number of results per page.