Projects

Get a project

get/projects/{id}

Request

  • Base URL: https://www.ruddr.io/api/workspace
  • URL: https://www.ruddr.io/api/workspace/projects/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The project uuid

Response

200

idstring

The unique identifier for the object.

keystring

The URL-friendly slug for the project.

namestring

The name of the project.

notesstring nullable

Notes associated with the project.

accountingNotesstring nullable

Accounting notes associated with the project.

statusId'tentative' | 'not_started' | 'in_progress' | 'paused' | 'completed' | 'cancelled'

The project status.

startstring date nullable

The start date for the project. Will be in the form YYYY-MM-DD.

endstring date nullable

The end date for the project. Will be in the form YYYY-MM-DD. null if no end date is set.

codestring nullable

The project code.

poNumberstring nullable

The purchase order number.

billingTypeId'tm' | 'fixed' | 'fixed_recurring' | 'non_billable'

The billing type for the project.

isBillableboolean

Whether this project is billable. Derived from billingTypeId — false only when billingTypeId is "non_billable".

currencystring

The 3-letter currency code associated with the project.

revenueRecognitionMethod'invoiced' | 'manual' | 'automated_hours' | 'automated_tm_basis' nullable

The revenue recognition method. Only applicable when billingTypeId is "fixed" or "fixed_recurring". null for other billing types.

revenueAttributionMethod'hours' | 'services_cost' | 'tm_basis' nullable

The revenue attribution method. Only applicable when billingTypeId is "fixed" or "fixed_recurring". null for other billing types.

fixedFeenumber nullable

Deprecated. Always null.

fixedRecurringFeenumber nullable

Deprecated. Always null.

fixedRecurringStartstring nullable

Deprecated. Always null.

fixedRecurringEndstring nullable

Deprecated. Always null.

useRolesboolean

Whether the project uses roles.

useRateCardsboolean

Whether the project can have more than one dated rate card. See the project rate cards endpoints.

useDependenciesboolean

Whether the project uses task dependencies. When disabled, tasks cannot have predecessors or successors.

autoCompleteMilestonesboolean

Whether a milestone is automatically completed once all of its predecessors are complete. Has no effect when task dependencies are disabled.

useBudgetboolean

Whether the project has a budget.

budgetMode'summary' | 'detailed' | 'aggregated' nullable

The budget mode. null when useBudget is false.

budgetRateCardIdstring

The ID (uuid) of the rate card whose rates price the project's budget. See the project rate cards endpoints.

useMonthlyBudgetboolean

Whether the project has a monthly budget.

monthlyBudgetMode'summary' | 'detailed' nullable

The monthly budget mode. null when useMonthlyBudget is false.

capMaxMemberHoursPerDayboolean

When enabled, caps the number of hours a member can log per day on the project.

maxMemberHoursPerDayinteger nullable

The maximum number of hours a member can log per day on the project. Only used if capMaxMemberHoursPerDay is true. null when capMaxMemberHoursPerDay is false.

capMaxMemberHoursPerWeekboolean

When enabled, caps the number of hours a member can log per week on the project.

maxMemberHoursPerWeekinteger nullable

The maximum number of hours a member can log per week on the project. Only used if capMaxMemberHoursPerWeek is true. null when capMaxMemberHoursPerWeek is false.

capMaxMemberHoursPerMonthboolean

When enabled, caps the number of hours a member can log per month on the project.

maxMemberHoursPerMonthinteger nullable

The maximum number of hours a member can log per month on the project. Only used if capMaxMemberHoursPerMonth is true. null when capMaxMemberHoursPerMonth is false.

requiresNotesboolean

Requires notes on time entries for this project.

requiresTasksboolean

Requires a task selection on time entries for this project.

recordStatusId'active' | 'archived'

The record status of the project.

isProductiveboolean nullable

Whether time logged on this project counts as productive time. Only applicable for internal client projects; null for external client projects.

lockTimeAndExpensesboolean

When enabled, locks time and expenses on the project, preventing further edits.

trackTimeToAssignedRolesboolean nullable

Whether time should be tracked per assigned role. Only applies when useRoles is true. null when useRoles is false.

restrictTimeToAllocatedDaysboolean

When enabled, members can only log time on days they are allocated to the project.

cloudFolderUrlstring nullable

The URL to the associated cloud storage folder.

createdAtstring date-time

The timestamp when the object was created.

modifiedAtstring date-time

The timestamp when the object was last modified.

completedOnstring date nullable

The date the project was completed. Only populated when statusId is "completed".

Changes

No recorded changes to this operation across all 1 revision of this API.