v1

latestOpenAPI 3.0.02026-07-13483586.3 KB

Projects

Pagination

List all projects

get/projects

Query parameters

projectNamestring

Filter projects by name

Example:Cloud migration

Filter projects by name

status'PLANNING' | 'ACTIVE' | 'COMPLETED' | 'ON_HOLD'

Status of the ongoing project's workflow

Example:ACTIVE

Filter projects by status

teamMembersstring

Filter projects by team member IDs according to teamMembersFiltering

Example:123,456,789

Filter projects by team member IDs

teamMembersFiltering'ANY' | 'ALL'

If more than one ID is passed, return either projects with any of the team members (ANY) or with all of them (ALL)

Example:ALL

How to match team members

budgetFromstring

Minimum project budget amount

Example:10000

Minimum project budget

budgetTostring

Maximum project budget amount

Example:50000

Maximum project budget

pagenumber

Page number to retrieve

Example:1

Specify the page number to retrieve

pageSizenumber

Number of elements per page

Example:1

Specify the number of items per page

sortBy'name' | 'status' | 'startDate' | 'endDate' | 'teamSize'

Sort projects by field

Example:startDate

Sort projects by field

sortOrder'asc' | 'desc'

Sort order

Example:asc

Sort order

Response

Successful operation

idstring required

namestring required

status'PLANNING' | 'ACTIVE' | 'COMPLETED' | 'ON_HOLD' required

Status of the ongoing project's workflow

budgetnumber required

Monetary value in EUR

startDatestring date required

endDatestring date

managerinteger required

descriptionstring required

teamSizeinteger required

Example response

[
  {
    "id": "579ef28f-c539-41ff-abe2-e4f6b1c1afed",
    "name": "Licensed Cotton Pants",
    "status": "on-hold",
    "budget": 490000,
    "startDate": "2013-04-16",
    "endDate": "2019-04-27",
    "team": [
      {
        "id": 4247456,
        "name": "Anna Bahringer"
      }
    ],
    "manager": 67429059,
    "description": "Deleniti rerum impedit.\nCum sed eaque quo accusantium."
  }
]