API Docs

Base URL: http://localhost:3000/api

Authentication

Register

Create a new user account.

• URL: /auth/register
• Method: POST
• Request Body:

  1
  {
  2
    "name": "John Doe",
  3
    "email": "john@example.com",
  4
    "password": "securepassword123"
  5
  }

• Success Response (201 Created):

  1
  {
  2
    "success": true,
  3
    "message": "Registration successful",
  4
    "data": {
  5
      "user": {
  6
        "id": 1,
  7
        "email": "john@example.com",
  8
        "name": "John Doe"
  9
      },
  10
      "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
  11
    }
  12
  }

Login

Authenticate a user and retrieve a token.

• URL: /auth/login
• Method: POST
• Request Body:

  1
  {
  2
    "email": "john@example.com",
  3
    "password": "securepassword123"
  4
  }

• Success Response (200 OK):

  1
  {
  2
    "success": true,
  3
    "message": "Login successful",
  4
    "data": {
  5
      "user": {
  6
        "id": 1,
  7
        "email": "john@example.com",
  8
        "name": "John Doe"
  9
      },
  10
      "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
  11
    }
  12
  }

Boards

Get All Boards

Retrieve all boards owned by the authenticated user.

• URL: /boards
• Method: GET
• Headers: Authorization: Bearer <token>
• Success Response (200 OK):

  1
  {
  2
    "success": true,
  3
    "message": "Boards retrieved successfully",
  4
    "data": [
  5
      {
  6
        "id": 1,
  7
        "title": "My Project",
  8
        "description": "Project management board",
  9
        "backgroundColor": "#0079bf",
  10
        "isPrivate": true,
  11
        "ownerId": 1,
  12
        "createdAt": "2023-10-27T10:00:00.000Z",
  13
        "updatedAt": "2023-10-27T10:00:00.000Z"
  14
      }
  15
    ]
  16
  }

Create Board

Create a new board.

• URL: /boards
• Method: POST
• Headers: Authorization: Bearer <token>
• Request Body:

  1
  {
  2
    "title": "New Board",
  3
    "description": "Description of the board",
  4
    "backgroundColor": "#0079bf",
  5
    "isPrivate": true
  6
  }

• Success Response (201 Created):

  1
  {
  2
    "success": true,
  3
    "message": "Board created successfully",
  4
    "data": {
  5
      "id": 2,
  6
      "title": "New Board",
  7
      "description": "Description of the board",
  8
      "backgroundColor": "#0079bf",
  9
      "isPrivate": true,
  10
      "ownerId": 1,
  11
      "createdAt": "2023-10-27T12:00:00.000Z",
  12
      "updatedAt": "2023-10-27T12:00:00.000Z"
  13
    }
  14
  }

Get Board Details

Retrieve a specific board by ID, including its lists and cards.

• URL: /boards/:id
• Method: GET
• Headers: Authorization: Bearer <token>
• Success Response (200 OK):

  1
  {
  2
    "success": true,
  3
    "message": "Board retrieved successfully",
  4
    "data": {
  5
      "id": 1,
  6
      "title": "My Project",
  7
      "lists": [
  8
        {
  9
          "id": 1,
  10
          "title": "To Do",
  11
          "position": 1,
  12
          "cards": [
  13
            {
  14
              "id": 1,
  15
              "title": "Task 1",
  16
              "position": 1
  17
            }
  18
          ]
  19
        }
  20
      ]
  21
    }
  22
  }

Update Board

Update board details.

• URL: /boards/:id
• Method: PUT
• Headers: Authorization: Bearer <token>
• Request Body:

  1
  {
  2
    "title": "Updated Title",
  3
    "description": "Updated description",
  4
    "backgroundColor": "#ff9f1a"
  5
  }

• Success Response (200 OK):

  1
  {
  2
    "success": true,
  3
    "message": "Board updated successfully",
  4
    "data": {
  5
      "id": 1,
  6
      "title": "Updated Title",
  7
      "backgroundColor": "#ff9f1a"
  8
    }
  9
  }

Delete Board

Delete a board.

• URL: /boards/:id
• Method: DELETE
• Headers: Authorization: Bearer <token>
• Success Response (200 OK):

  1
  {
  2
    "success": true,
  3
    "message": "Board deleted successfully",
  4
    "data": null
  5
  }

Lists

Get Lists

Get all lists for a specific board.

• URL: /lists?boardId=:boardId
• Method: GET
• Headers: Authorization: Bearer <token>
• Success Response (200 OK):

  1
  {
  2
    "success": true,
  3
    "message": "Lists retrieved successfully",
  4
    "data": [
  5
      {
  6
        "id": 1,
  7
        "title": "To Do",
  8
        "position": 1,
  9
        "boardId": 1
  10
      }
  11
    ]
  12
  }

Create List

Create a new list in a board.

• URL: /lists
• Method: POST
• Headers: Authorization: Bearer <token>
• Request Body:

  1
  {
  2
    "title": "Doing",
  3
    "boardId": 1,
  4
    "position": 2
  5
  }

• Success Response (201 Created):

  1
  {
  2
    "success": true,
  3
    "message": "List created successfully",
  4
    "data": {
  5
      "id": 2,
  6
      "title": "Doing",
  7
      "boardId": 1,
  8
      "position": 2
  9
    }
  10
  }

Update List

Update a list’s title or archive status.

• URL: /lists/:id
• Method: PUT
• Headers: Authorization: Bearer <token>
• Request Body:

  1
  {
  2
    "title": "In Progress",
  3
    "isArchived": false
  4
  }

• Success Response (200 OK):

  1
  {
  2
    "success": true,
  3
    "message": "List updated successfully",
  4
    "data": {
  5
      "id": 2,
  6
      "title": "In Progress",
  7
      "isArchived": false
  8
    }
  9
  }

Move List

Change the position of a list.

• URL: /lists/:id/move
• Method: PUT
• Headers: Authorization: Bearer <token>
• Request Body:

  1
  {
  2
    "position": 1
  3
  }

• Success Response (200 OK):

  1
  {
  2
    "success": true,
  3
    "message": "List moved successfully",
  4
    "data": [ /* Array of lists in new order */ ]
  5
  }

Delete List

Delete a list.

• URL: /lists/:id
• Method: DELETE
• Headers: Authorization: Bearer <token>
• Success Response (200 OK):

  1
  {
  2
    "success": true,
  3
    "message": "List deleted successfully",
  4
    "data": null
  5
  }

Cards

Get Cards

Get all cards in a list.

• URL: /cards?listId=:listId
• Method: GET
• Headers: Authorization: Bearer <token>
• Success Response (200 OK):

  1
  {
  2
    "success": true,
  3
    "message": "Cards retrieved successfully",
  4
    "data": [
  5
      {
  6
        "id": 1,
  7
        "title": "Fix Bug",
  8
        "listId": 1
  9
      }
  10
    ]
  11
  }

Create Card

Create a new card in a list.

• URL: /cards
• Method: POST
• Headers: Authorization: Bearer <token>
• Request Body:

  1
  {
  2
    "title": "Implement Login",
  3
    "description": "Add JWT authentication",
  4
    "listId": 1,
  5
    "position": 1,
  6
    "dueDate": "2023-12-31T23:59:59Z"
  7
  }

• Success Response (201 Created):

  1
  {
  2
    "success": true,
  3
    "message": "Card created successfully",
  4
    "data": {
  5
      "id": 3,
  6
      "title": "Implement Login",
  7
      "listId": 1
  8
    }
  9
  }

Get Card Details

Get details of a single card.

• URL: /cards/:id
• Method: GET
• Headers: Authorization: Bearer <token>
• Success Response (200 OK):

  1
  {
  2
    "success": true,
  3
    "message": "Card retrieved successfully",
  4
    "data": {
  5
      "id": 3,
  6
      "title": "Implement Login",
  7
      "description": "Add JWT authentication",
  8
      "dueDate": "2023-12-31T23:59:59.000Z"
  9
    }
  10
  }

Update Card

Update card details.

• URL: /cards/:id
• Method: PUT
• Headers: Authorization: Bearer <token>
• Request Body:

  1
  {
  2
    "title": "Implement Login (Revised)",
  3
    "description": "Updated description",
  4
    "dueDate": "2024-01-01T12:00:00Z"
  5
  }

• Success Response (200 OK):

  1
  {
  2
    "success": true,
  3
    "message": "Card updated successfully",
  4
    "data": { "id": 3, "title": "Implement Login (Revised)" }
  5
  }

Move Card

Move a card to a different position or list.

• URL: /cards/:id/move
• Method: PUT
• Headers: Authorization: Bearer <token>
• Request Body:

  1
  {
  2
    "listId": 2,
  3
    "position": 1
  4
  }

• Success Response (200 OK):

  1
  {
  2
    "success": true,
  3
    "message": "Card moved successfully",
  4
    "data": { "id": 3, "listId": 2, "position": 1 }
  5
  }

Toggle Card Completion

Toggle the isCompleted status of a card.

• URL: /cards/:id/complete
• Method: PUT
• Headers: Authorization: Bearer <token>
• Success Response (200 OK):

  1
  {
  2
    "success": true,
  3
    "message": "Card status updated successfully",
  4
    "data": {
  5
      "id": 3,
  6
      "isCompleted": true
  7
    }
  8
  }

Delete Card

Delete a card.

• URL: /cards/:id
• Method: DELETE
• Headers: Authorization: Bearer <token>
• Success Response (200 OK):

  1
  {
  2
    "success": true,
  3
    "message": "Card deleted successfully",
  4
    "data": null
  5
  }