Search projects

GET 
/api/v1/project/search

Search projects

Request

Query Parameters

query string

The search term (matches project name or partial match)

status string
Filter by project status (active, completed, on-hold)
Example: active
includeUnassociated boolean
Include projects not owned or associated with the user
Example: false
page number
The page number to fetch (default: 1)
Example: 1
perPage number
Number of projects per page (default: 15)
Example: 15

Responses

200

application/json

Schema

Schema

data

object[]

required

The data items for the current page

Array [

id numberrequired

Unique identifier of the project

name stringrequired

Unique slug name of the project

projectName string

Human-friendly name of the project (not unique)

description string

projectType stringrequired

Possible values: [product, formation]

status string

Status of the project (active, completed, on-hold)

label string

Label name assigned to the project

]

total numberrequired

The total number of items available

page numberrequired

The current page number

perPage numberrequired

The number of items per page

Example (from schema)

{
  "data": [
    {
      "id": 0,
      "name": "string",
      "projectName": "string",
      "description": "string",
      "projectType": "product",
      "status": "string",
      "label": "string"
    }
  ],
  "total": 100,
  "page": 1,
  "perPage": 10
}

Loading...