BoardAPI Documentation

Appearance

Users API ​

The Users API allows you to manage your user profile and organization context.

Get Profile ​

Retrieves the profile information for the currently authenticated user.

  • URL: /me/profile
  • Method: GET
  • Headers:
    • Authorization: Bearer <jwt-token>

Response ​

json
{
  "id": "user-uuid",
  "email": "user@example.com",
  "name": "John Doe",
  "created_at": "2025-11-17T10:00:00.000Z",
  "updated_at": "2025-11-17T10:00:00.000Z",
  "current_organization_id": "org-uuid"
}

Update Profile ​

Updates the profile information for the currently authenticated user.

  • URL: /me/profile
  • Method: PATCH
  • Headers:
    • Authorization: Bearer <jwt-token>
  • Body:
json
{
  "name": "John Doe", // Optional
  "password": "NewPass123", // Optional
  "currentPassword": "OldPass123" // Required if changing password
}

Response ​

json
{
  "id": "user-uuid",
  "email": "user@example.com",
  "name": "John Doe",
  "updated_at": "2025-11-17T10:00:00.000Z"
}

Get Boards ​

Retrieves all boards for the organization currently associated with the authenticated user.

  • URL: /me/boards
  • Method: GET
  • Headers:
    • Authorization: Bearer <jwt-token>
  • Query Parameters:
    • status: Filter by status (e.g., active, archived)

Response ​

json
[
  {
    "id": "uuid",
    "title": "My Board",
    "board_uuid": "board-uuid",
    "organization_id": "org-uuid",
    "status": "active",
    "created_at": "2025-11-17T10:00:00.000Z",
    "updated_at": "2025-11-17T10:00:00.000Z"
  }
]

Get Organizations ​

Retrieves a list of all organizations that the currently authenticated user is a member of.

  • URL: /me/organizations
  • Method: GET
  • Headers:
    • Authorization: Bearer <jwt-token>

Response ​

json
[
  {
    "id": "org-uuid",
    "name": "Organization Name",
    "created_at": "2025-11-17T10:00:00.000Z"
  }
]

Switch Organization ​

Changes the currently active organization for the authenticated user and returns a new JWT token.

  • URL: /me/organizations/:id/switch
  • Method: POST
  • Headers:
    • Authorization: Bearer <jwt-token>

Response ​

json
{
  "access_token": "jwt-token-here",
  "user": {
    "id": "user-uuid",
    "email": "user@example.com",
    "current_organization_id": "org-uuid"
  }
}