v2

latestSwagger 2.02026-08-04108164321.0 KB
Project

Retrieves full project details by Project ID, including sections, team members with rates and permissions, and project tags.

get/api/Project/{id}

Path parameters

idinteger required

Project ID number

Response

Returns full project details including sections, members, and tags.

ProjectIDinteger

Unique identifier for the project.

Titlestring

Project title/name.

ProjectCodestring

Short reference code for the project.

Notesstring

Project description or notes.

CompanyNamestring

Name of the customer company this project belongs to.

CompanyIDFKinteger

The customer company ID this project is linked to.

ProjectOwnerUserIDFKinteger

User ID of the project owner/manager.

ProjectStatusCodestring

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.

ProjectStatusNamestring

Display name of the project status (e.g. "In Progress", "At Risk").

ProjectStatusColorstring

Hex colour assigned to the project status (e.g. "#F0AD4E").

ProjectStatusIsNotStartedboolean

True if this is the account's default-for-new-projects status (one row per account).

ProjectStatusIsCompleteboolean

True if this status marks the project as complete (one row per account).

isArchivedboolean

Whether the project is archived. Archived projects are hidden from default views.

ProjectBillableTypeCodestring

Possible values: CategoryHourly, NoRate, NotBillable, PersonHourly, ProjectHourly

ProjectBudgetTypeCodestring

Possible Values: CategoryHours, NoBudget, PersonHours, ProjectFees, ProjectHours

BudgetAmountnumber double

Monetary budget allocated to the project.

BudgetHoursnumber double

Hours budget allocated to the project.

ProjectHourlyRatenumber double

The project-level hourly rate (when billing type is ProjectHourly).

ProjectCategoryIDFKinteger

The project category ID, if categorised.

ProjectCategoryNamestring

Name of the project category.

isTaskRequiredOnTimesheetboolean

Whether users must select a task when logging time to this project.

DefaultAccountTaskTypeIDFKinteger

The default task type ID used for new tasks in this project.

DefaultAccountTaskTypeNamestring

Name of the default task type.

ProjectCategoryColorstring

Html Hex Color Code starting with #

StartDatestring date-time

Planned start date for the project.

EndDatestring date-time

Planned end date for the project.

DateCreatedstring date-time

Date the project was created.

DateUpdatedstring date-time

Date the project was last updated.

ViewProjectURLstring

URL to view this project in the Avaza web application.