Projects

List projects for current user

get

List all projects that the current user has access to.

Authorizations
Query parameters
pageinteger · min: 1OptionalDefault: 1Example: 1
limitinteger · min: 1Optional

Max number of projects to return

Default: 10Example: 10
Responses
200
Successful Response
application/json
get
GET /projects/ HTTP/1.1
Host: localhost:8000
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "data": {
    "items": [
      {
        "name": "text",
        "description": "text",
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "created_at": "2025-07-03T02:09:11.318Z",
        "updated_at": "2025-07-03T02:09:11.318Z"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 1,
      "total": 1,
      "pages": 1
    }
  },
  "error": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Create a new project

post

Create a new project and add the current user as an admin.

Authorizations
Body

Model for creating a new project.

namestring · min: 1 · max: 255Required

Project name

descriptionany ofOptional

Project description

stringOptional
or
nullOptional
Responses
201
Successful Response
application/json
post
POST /projects/ HTTP/1.1
Host: localhost:8000
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 35

{
  "name": "Ellen",
  "description": null
}
{
  "success": true,
  "data": {
    "name": "text",
    "description": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2025-07-03T02:09:11.318Z",
    "updated_at": "2025-07-03T02:09:11.318Z"
  },
  "error": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Get project details

get

Get detailed project information including members.

Authorizations
Path parameters
project_idstring · uuidRequiredExample: 3f891542-df96-4ec6-9577-be733c628ea0
Responses
200
Successful Response
application/json
get
GET /projects/{project_id} HTTP/1.1
Host: localhost:8000
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "data": {
    "name": "text",
    "description": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2025-07-03T02:09:11.318Z",
    "updated_at": "2025-07-03T02:09:11.318Z",
    "members": [
      {
        "user_id": "123e4567-e89b-12d3-a456-426614174000",
        "email": "text",
        "full_name": "text",
        "role": "text"
      }
    ]
  },
  "error": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Update project details

patch

Update project details (requires admin role).

Authorizations
Path parameters
project_idstring · uuidRequired

Project ID to operate on

Example: 3f891542-df96-4ec6-9577-be733c628ea0
Body

Model for updating a project.

nameany ofOptional

Project name

string · min: 1 · max: 255Optional
or
nullOptional
descriptionany ofOptional

Project description

stringOptional
or
nullOptional
Responses
200
Successful Response
application/json
patch
PATCH /projects/{project_id} HTTP/1.1
Host: localhost:8000
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 97

{
  "name": "Excepteur in reprehenderit officia-changed",
  "description": "cillum tempor culpa-changed"
}
{
  "success": true,
  "data": {
    "name": "text",
    "description": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2025-07-03T02:09:11.318Z",
    "updated_at": "2025-07-03T02:09:11.318Z"
  },
  "error": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Add member to project

post

Add a user to the project (requires admin role).

Authorizations
Path parameters
project_idstring · uuidRequired

Project ID to operate on

Example: 3f891542-df96-4ec6-9577-be733c628ea0
Body

Model for adding a member to a project.

user_idstring · uuidRequired

User ID to add to the project

rolestring · enumRequired

Role in the project (admin, editor, viewer)

Possible values:
Responses
201
Successful Response
application/json
post
POST /projects/{project_id}/members HTTP/1.1
Host: localhost:8000
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "user_id": "12",
  "role": "admin"
}
{
  "success": true,
  "data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "error": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Remove member from project

delete

Remove a user from the project (requires admin role).

Authorizations
Path parameters
user_idstring · uuidRequiredExample: f1d820e5-1f9b-4b41-a6a6-442121449420
project_idstring · uuidRequired

Project ID to operate on

Example: fc00f687-9030-40ad-8e4f-7f13586045f7
Responses
200
Successful Response
application/json
delete
DELETE /projects/{project_id}/members/{user_id} HTTP/1.1
Host: localhost:8000
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "error": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}

Update member role

patch

Update a member's role in the project (requires admin role).

Authorizations
Path parameters
user_idstring · uuidRequiredExample: f1d820e5-1f9b-4b41-a6a6-442121449420
project_idstring · uuidRequired

Project ID to operate on

Example: fc00f687-9030-40ad-8e4f-7f13586045f7
Body

Model for updating a member's role in a project.

rolestring · enumRequired

Role in the project (admin, editor, viewer)

Possible values:
Responses
200
Successful Response
application/json
patch
PATCH /projects/{project_id}/members/{user_id} HTTP/1.1
Host: localhost:8000
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "role": "admin"
}
{
  "success": true,
  "data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "error": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  }
}
PreviousDocumentsNextModels