TODO for AI Logo
TODOforAI API

Project

Endpoint:/api/v1

Project management operations


List projects

GET
/api/v1
/projects

Returns a list of projects for the authenticated user

List projects Responses

Successful operation

  • projectobject
  • settingsobject

Create project

POST
/api/v1
/projects

Creates a new project for the authenticated user

Create project Request Body

  • namestring · required
    Example: My Project
  • isPublicboolean · required
    Example: false
  • descriptionstring
    Example: A description of my project

Create project Responses

Project created successfully

  • projectobject
  • settingsobject

Project by ID

GET
/api/v1
/projects/{projectId}

Returns a single project by ID

Project by IDpath Parameters

  • projectIdstring · required

    ID of the project to retrieve

Project by ID Responses

Successful operation

  • projectobject
  • settingsobject

Update project

PUT
/api/v1
/projects/{projectId}

Updates a project with the provided data

Update projectpath Parameters

  • projectIdstring · required

    ID of the project to update

Update project Request Body

  • namestring
    Example: Updated Project Name
  • descriptionstring
    Example: Updated project description
  • isPublicboolean
    Example: true
  • statusstring · enum
    Enum values:
    ACTIVE
    ARCHIVED
    DELETED
    Example: ACTIVE

Update project Responses

Project updated successfully

  • successboolean
    Example: true
  • messagestring
    Example: Operation completed successfully

Delete project

DELETE
/api/v1
/projects/{projectId}

Deletes a project by ID

Delete projectpath Parameters

  • projectIdstring · required

    ID of the project to delete

Delete project Responses

Project deleted successfully

  • successboolean
    Example: true
  • messagestring
    Example: Operation completed successfully

List todos for project

GET
/api/v1
/projects/{projectId}/todos

Returns a list of todos for a specific project

List todos for projectpath Parameters

  • projectIdstring · required

    ID of the project

List todos for project Responses

Successful operation

  • idstring
    Example: todo-123
  • projectIdstring
    Example: project-123
  • statusstring · enum
    Enum values:
    LISTENING
    THINKING
    DONE
    FAILED
    CANCELLED
    SCHEDULED
    Example: LISTENING
  • contentstring
    Example: Task description
  • createdAtinteger · int64
    Example: 1625097600000
  • lastActivityAtinteger · int64
    Example: 1625097600000
  • scheduledTimestampinteger · int64
    Example: 1625097600000

Get project settings

GET
/api/v1
/settings/projects/{projectId}

Returns the settings for a specific project

Get project settingspath Parameters

  • projectIdstring · required

    ID of the project

Get project settings Responses

Successful operation

  • idstring
    Example: settings-123
  • projectIdstring
    Example: project-123

Update project settings

PUT
/api/v1
/settings/projects/{projectId}

Updates the settings for a specific project

Update project settingspath Parameters

  • projectIdstring · required

    ID of the project

Update project settings Request Body

  • idstring
    Example: settings-123
  • projectIdstring
    Example: project-123

Update project settings Responses

Project settings updated successfully

  • idstring
    Example: settings-123
  • projectIdstring
    Example: project-123