---
title: "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."
method: GET
path: "/api/Project"
tags: ["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

- `UpdatedAfter` string, date-time
- `pageSize` integer
- `pageNumber` integer
- `Sort` string
- `TimesheetUserID` integer
- `CompanyID` integer
- `ProjectCategoryID` integer
- `ProjectOwnerUserID` integer
- `ProjectStatusCode` string
- `ProjectBillableTypeCode` string
- `ProjectBudgetTypeCode` string
- `DateCreatedFrom` string, date-time
- `DateCreatedTo` string, date-time
- `includeArchived` boolean
- `Tags` string[]
- `TagMatchMode` string

## Response `200`

Returns a paginated list of projects with details.

- ProjectList — Paginated collection of projects with summary details.
  - `Projects` ProjectListDetails[] — List of projects in this page.
    - `ProjectID` integer — Unique identifier for the project.
    - `ProjectCode` string — Short reference code for the project.
    - `Title` string — Project title/name.
    - `isArchived` boolean — Whether the project is archived. Archived projects are hidden from default views.
    - `Notes` string — Project description or notes.
    - `CompanyName` string — Name of the customer company this project belongs to.
    - `CompanyIDFK` integer — The customer company ID this project is linked to.
    - `ProjectCategoryIDFK` integer — The project category ID, if categorised.
    - `ProjectCategoryName` string — Name of the project category.
    - `isTaskRequiredOnTimesheet` boolean — Whether users must select a task when logging time to this project.
    - `DefaultAccountTaskTypeIDFK` integer — The default task type ID used for new tasks in this project.
    - `DefaultAccountTaskTypeName` string — Name of the default task type.
    - `ProjectOwnerUserIDFK` integer — User ID of the project owner/manager.
    - `DateCreated` string, date-time — Date the project was created.
    - `DateUpdated` string, date-time — Date the project was last updated.
    - `ProjectStatusCode` string — Project status code. Per-account configurable. Default codes (NotStarted, InProgress, Complete, OnHold) are seeded for every account; admins may add custom codes via the Project Statuses settings panel. Codes are unique within an account and stable once created.
    - `ProjectStatusName` string — Display name of the project status (e.g. "In Progress", "At Risk").
    - `ProjectStatusColor` string — Hex colour assigned to the project status (e.g. "#F0AD4E").
    - `ProjectStatusIsNotStarted` boolean — True if this is the account's default-for-new-projects status (one row per account).
    - `ProjectStatusIsComplete` boolean — True if this status marks the project as complete (one row per account).
    - `ProjectBillableTypeCode` string — Billing configuration. Values: CategoryHourly, NoRate, NotBillable, PersonHourly, ProjectHourly.
    - `ProjectBudgetTypeCode` string — Budget configuration. Values: CategoryHours, NoBudget, PersonHours, ProjectFees, ProjectHours.
    - `BudgetAmount` number, double — Monetary budget allocated to the project.
    - `BudgetHours` number, double — Hours budget allocated to the project.
    - `ProjectHourlyRate` number, double — The project-level hourly rate (when billing type is ProjectHourly).
    - `StartDate` string, date-time — Planned start date for the project.
    - `EndDate` string, date-time — Planned end date for the project.
    - `ViewProjectURL` string — URL to view this project in the Avaza web application.
    - `ProjectTags` ProjectTagItem[] — List of tags applied to this project, alphabetical by name.
      - `ProjectTagID` integer — Unique identifier for the project tag.
      - `Name` string — Tag name.
  - `TotalCount` integer — Total number of projects matching the query.
  - `PageNumber` integer — Current page number (1-based).
  - `PageSize` integer — Number of results per page.

---

[API](https://skmtc.net/avaza/apis/avaza-api-documentation.md) · [All operations](https://skmtc.net/avaza/apis/avaza-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/avaza/avaza-api-documentation/versions/1eeadf750514/schema)