API ReferenceProjects
List projects
Get all projects accessible to the authenticated user
AuthorizationBearer <token>
Clerk authentication token
In: header
Query Parameters
status?string
Value in
"active" | "on_hold" | "completed" | "archived"clientId?string
Match
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000)$Format
uuidlimit?string
offset?string
Response Body
curl -X GET "http://localhost:3001/projects?status=active&clientId=497f6eca-6276-4993-bfeb-53cbbbba6f08&limit=string&offset=string"{
"projects": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"status": "string",
"clientId": "5e505642-9024-474d-9434-e5a44f505cc5",
"clientName": "string",
"contactId": "b5ec5d98-4bee-4da1-ad24-dde86346cb1d",
"startDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"ownerUserId": "string",
"organizationId": "string",
"isPinned": true,
"pinnedAt": "2019-08-24T14:15:22Z",
"sowCount": 0,
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"total": 0
}{
"code": "BAD_REQUEST",
"message": "Invalid input data",
"issues": []
}{
"code": "UNAUTHORIZED",
"message": "Authorization not provided",
"issues": []
}{
"code": "FORBIDDEN",
"message": "Insufficient access",
"issues": []
}{
"code": "NOT_FOUND",
"message": "Not found",
"issues": []
}{
"code": "INTERNAL_SERVER_ERROR",
"message": "Internal server error",
"issues": []
}