Skip to main content
POST
Search Projects

Authorizations

x-client-key
string
header
required
x-client-secret
string
header
required

Path Parameters

workspaceId
string<uuid>
required

UUID of the workspace. Must be the workspace the API key belongs to.

Example:

"cb363f7e-c52a-4478-911d-f6a6f791090e"

Body

application/json
offset
integer
default:0

Row offset to start from.

limit
integer
default:10

Maximum rows to return.

searchText
string
default:""

Case-insensitive match on the project title.

sortField
string
default:createdAt

Column to sort by.

sortOrder
enum<string>
default:DESC
Available options:
ASC,
DESC
status
enum<string>
default:ALL

Lifecycle filter. PAUSED matches projects paused via the toggle-pause endpoint; EXPIRED matches projects whose schedules have ended.

Available options:
ALL,
ACTIVE,
PAUSED,
EXPIRED
advanceFilters
object | null

Optional additional filter object, same shape the task list endpoints accept.

Response

Projects retrieved successfully, with pagination metadata.