Sign in

v1

latestOpenAPI 3.0.12026-08-041753011.2 MB
Project

Find a project by ID

get/v1/workspaces/{workspaceId}/projects/{projectId}

Path parameters

workspaceIdstring required

Represents a workspace identifier across the system.

Example:64a687e29ae1f428e7ebe303

Represents a workspace identifier across the system.

projectIdstring required

Represents a project identifier across the system.

Example:5b641568b07987035750505e

Represents a project identifier across the system.

Query parameters

hydratedboolean

If set to true, results will contain additional information about the project

If set to true, results will contain additional information about the project

custom-field-entity-typestring

If provided, you'll get a filtered list of custom fields that matches the provided string with the custom field entity type.

expense-limitinteger

Represents the maximum number of expenses to fetch.

Example:10

Represents the maximum number of expenses to fetch.

expense-datestring

If provided, you will get expenses dated before the provided value in yyyy-MM-dd format.

Example:2024-12-31

If provided, you will get expenses dated before the provided value in yyyy-MM-dd format.

Response

OK

archivedboolean

Indicates whether project is archived or not.

billableboolean

Indicates whether project is billable or not.

colorstring

Color format ^#(?:[0-9a-fA-F]{6}){1}$. Explanation: A valid color code should start with '#' and consist of six hexadecimal characters, representing a color in hexadecimal format. Color value is in standard RGB hexadecimal format.

durationstring

Represents project duration in milliseconds.

idstring

Represents project identifier across the system.

namestring

Represents a project name.

notestring

Represents project note.

publicboolean

Indicates whether project is public or not.

templateboolean

Indicates whether project is a template or not.

workspaceIdstring

Represents workspace identifier across the system.

Example response

{
  "budgetEstimate": {
    "estimate": 600000,
    "resetOption": "WEEKLY",
    "type": "AUTO"
  },
  "color": "#000000",
  "costRate": {
    "amount": 10500,
    "currency": "USD"
  },
  "duration": "60000",
  "estimate": {
    "estimate": "PT1H30M",
    "type": "AUTO"
  },
  "hourlyRate": {
    "amount": 10500,
    "currency": "USD"
  },
  "id": "5b641568b07987035750505e",
  "memberships": [
    {
      "costRate": {
        "amount": 10500,
        "currency": "USD"
      },
      "hourlyRate": {
        "amount": 10500,
        "currency": "USD"
      },
      "membershipStatus": "PENDING",
      "membershipType": "PROJECT",
      "targetId": "64c777ddd3fcab07cfbb210c",
      "userId": "5a0ab5acb07987125438b60f"
    }
  ],
  "name": "Software Development",
  "note": "This is a sample note for the project.",
  "timeEstimate": {
    "estimate": "60000",
    "resetOption": "WEEKLY",
    "type": "AUTO"
  },
  "workspaceId": "64a687e29ae1f428e7ebe303"
}