v1

latestOpenAPI 3.0.12026-08-041753011.2 MB

Project

Get all projects on a workspace

get/v1/workspaces/{workspaceId}/projects

Path parameters

workspaceIdstring required

Represents a workspace identifier across the system.

Example:64a687e29ae1f428e7ebe303

Represents a workspace identifier across the system.

Query parameters

namestring

If provided, you'll get a filtered list of projects that contains the provided string in the project name.

Example:Software Development

If provided, you'll get a filtered list of projects that contains the provided string in the project name.

strict-name-searchboolean

Flag to toggle on/off strict search mode. When set to true, search by name will only return projects whose name exactly matches the string value given for the 'name' parameter. When set to false, results will also include projects whose name contain the string value, but could be longer than the string value itself. For example, if there is a project with the name 'applications', and the search value is 'app', setting strict-name-search to true will not return that project in the results, whereas setting it to false will.

archivedboolean

If provided and set to true, you'll only get archived projects. If omitted, you'll get both archived and non-archived projects.

billableboolean

If provided and set to true, you'll only get billable projects. If omitted, you'll get both billable and non-billable projects.

clientsstring[]

If provided, you'll get a filtered list of projects that contain clients which match any of the provided ids.

[
  "5a0ab5acb07987125438b60f",
  "64c777ddd3fcab07cfbb210c"
]

contains-clientboolean

If set to true, you'll get a filtered list of projects that contain clients which match the provided id(s) in 'clients' field. If set to false, you'll get a filtered list of projects which do NOT contain clients that match the provided id(s) in 'clients' field.

client-status'ACTIVE' | 'ARCHIVED' | 'ALL'

Filters projects based on client status provided.

usersstring[]

If provided, you'll get a filtered list of projects that contain users which match any of the provided ids.

[
  "5a0ab5acb07987125438b60f",
  "64c777ddd3fcab07cfbb210c"
]

contains-userboolean

If set to true, you'll get a filtered list of projects that contain users which match the provided id(s) in 'users' field. If set to false, you'll get a filtered list of projects which do NOT contain users which match the provided id(s) in 'users' field.

user-status'PENDING' | 'ACTIVE' | 'DECLINED' | 'INACTIVE' | 'ALL'

Filters projects based on user status provided.

is-templateboolean

Filters projects based on whether they are used as a template or not.

Sorts the results by the given column/field.

sort-order'ASCENDING' | 'DESCENDING'

Sorting mode.

hydratedboolean

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

pageinteger

Page number.

Example:1

Page number.

page-sizeinteger

Page size.

Example:50

Page size.

access'PUBLIC' | 'PRIVATE'

Valid set of string(s). If provided, you'll get a filtered list of projects that matches the provided access.

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.

userGroupsstring[]

If provided, you'll get a filtered list of projects that contain groups which match any of the provided ids.

[
  "5a0ab5acb07987125438b60f",
  "64c777ddd3fcab07cfbb210c"
]

contains-groupboolean

If set to true, you'll get a filtered list of projects that contain groups which match the provided id(s) in 'userGroups' field. If set to false, you'll get a filtered list of projects which do NOT contain groups which match the provided id(s) in 'userGroups' field.

Response

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"
  }
]