Project Endpoints
| Method | Path | Scope | Description |
|---|
GET | /projects | projects:read | List projects |
POST | /projects | projects:write | Create a project |
GET | /projects/:id | projects:read | Get a project |
PATCH | /projects/:id | projects:write | Update a project |
DELETE | /projects/:id | projects:write | Delete a project |
POST | /projects/:id/move | projects:write | Move project to a folder |
Folder Endpoints
| Method | Path | Scope | Description |
|---|
GET | /folders | projects:read | List folders |
POST | /folders | projects:write | Create a folder |
PATCH | /folders/:id | projects:write | Update a folder |
DELETE | /folders/:id | projects:write | Delete a folder |
List Projects
curl "https://my.clarife.app/api/v1/projects?limit=20&offset=0" \
-H "Authorization: Bearer clrf_your_key"
| Param | Type | Default | Description |
|---|
limit | integer | 50 | Results per page (max 100) |
offset | integer | 0 | Number of results to skip |
folder_id | uuid | — | Filter by parent folder |
{
"data": [
{
"id": "p1a2b3c4-...",
"name": "Product Docs",
"icon": "book",
"color": "#6366F1",
"folder_id": null,
"document_count": 12,
"created_at": "2026-03-10T08:00:00Z"
}
],
"total": 1,
"limit": 20,
"offset": 0
}
Create a Project
curl -X POST https://my.clarife.app/api/v1/projects \
-H "Authorization: Bearer clrf_your_key" \
-H "Content-Type: application/json" \
-d '{
"name": "Onboarding Guides",
"icon": "graduation-cap",
"color": "#10B981",
"folder_id": "f1a2b3c4-..."
}'
| Field | Type | Required | Description |
|---|
name | string | Yes | Project name (max 100 chars) |
icon | string | No | Icon identifier (67 available) |
color | string | No | Hex color code |
folder_id | uuid | No | Parent folder |
Get a Project
curl https://my.clarife.app/api/v1/projects/p1a2b3c4-... \
-H "Authorization: Bearer clrf_your_key"
Update a Project
curl -X PATCH https://my.clarife.app/api/v1/projects/p1a2b3c4-... \
-H "Authorization: Bearer clrf_your_key" \
-H "Content-Type: application/json" \
-d '{ "name": "New Name", "color": "#EF4444" }'
Delete a Project
curl -X DELETE https://my.clarife.app/api/v1/projects/p1a2b3c4-... \
-H "Authorization: Bearer clrf_your_key"
Deleting a project does not delete its documents. Documents are unlinked and moved to the root level.
Move a Project
Move a project into a different folder (or to the root level by passing null):
curl -X POST https://my.clarife.app/api/v1/projects/p1a2b3c4-.../move \
-H "Authorization: Bearer clrf_your_key" \
-H "Content-Type: application/json" \
-d '{ "folder_id": "f2b3c4d5-..." }'
List Folders
curl https://my.clarife.app/api/v1/folders \
-H "Authorization: Bearer clrf_your_key"
Create a Folder
curl -X POST https://my.clarife.app/api/v1/folders \
-H "Authorization: Bearer clrf_your_key" \
-H "Content-Type: application/json" \
-d '{ "name": "Q2 Documentation" }'
| Field | Type | Required | Description |
|---|
name | string | Yes | Folder name (max 100 chars) |
Update a Folder
curl -X PATCH https://my.clarife.app/api/v1/folders/f1a2b3c4-... \
-H "Authorization: Bearer clrf_your_key" \
-H "Content-Type: application/json" \
-d '{ "name": "Renamed Folder" }'
Delete a Folder
curl -X DELETE https://my.clarife.app/api/v1/folders/f1a2b3c4-... \
-H "Authorization: Bearer clrf_your_key"
Deleting a folder moves its projects to the root level. Projects and their documents are not deleted.
