Projects API

A RESTful API to manage Holberton pedagogical projects.

API v1OpenAPI JSONOpenAPI YAML
GET/api/v1/projectsprojects:read

Retrieve all projects with optional filtering

curl "http://localhost:3000/api/v1/projects" \
  -H "Authorization: Bearer YOUR_API_KEY"
POST/api/v1/projectsprojects:write

Create a new project

curl -X POST "http://localhost:3000/api/v1/projects" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Test project"
}'
GET/api/v1/projects/{id}projects:read

Retrieve a project by its ID

curl "http://localhost:3000/api/v1/projects/00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY"
PATCH/api/v1/projects/{id}projects:write

Update a project.

curl -X PATCH "http://localhost:3000/api/v1/projects/00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "intra": null
}'
DELETE/api/v1/projects/{id}projects:delete

Delete a project

curl -X DELETE "http://localhost:3000/api/v1/projects/00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY"