latestOpenAPI 3.1.02026-08-211061591.1 MB

69a962f1578f

Projects

Join

Only used for workspaces

This endpoint is used to join a workspace project by a workspace_user and is only usable by the workspace user.

post/api/v1/projects/{project_id}/join

Path parameters

project_idstring required

String ID of the workspace project to join.

Example:6XGgm6PHrGgMpCFX

Response

Successful Response

collaborator_statesobject[] required

Collaborator state records for the joined project.

Example response

{
  "project": {
    "id": "6XGgm6PHrGgMpCFX",
    "can_assign_tasks": true,
    "can_comment": true,
    "child_order": 1,
    "order_key": "a0",
    "color": "charcoal",
    "creator_uid": "1234567",
    "created_at": "2025-01-15T10:30:00Z",
    "name": "Inbox",
    "updated_at": "2025-01-16T10:30:00Z",
    "view_style": "list",
    "default_order": 1,
    "description": "Tasks for the launch plan",
    "public_key": "550e8400-e29b-41d4-a716-446655440000",
    "access": {
      "configuration": {
        "hide_collaborator_details": true,
        "disable_duplication": true
      }
    },
    "role": "admin",
    "parent_id": "6XGgm6PHrGgMpCFX"
  },
  "tasks": [
    {
      "user_id": "1234567",
      "id": "6XGgmFVcrG5RRjVr",
      "project_id": "6XGgm6PHrGgMpCFX",
      "section_id": "6fFPHV272WWh3gpW",
      "parent_id": "6XGgmFVcrG5RRjVr",
      "added_by_uid": "1234567",
      "assigned_by_uid": "1234567",
      "responsible_uid": "1234567",
      "labels": [
        "priority"
      ],
      "deadline": {
        "date": "2025-02-12",
        "lang": "en"
      },
      "duration": {
        "amount": 30,
        "unit": "minute"
      },
      "added_at": "2025-01-15T10:30:00Z",
      "completed_at": "2025-01-16T10:30:00Z",
      "completed_by_uid": "1234567",
      "updated_at": "2025-01-17T10:30:00Z",
      "due": {
        "date": "2025-02-12",
        "is_recurring": false,
        "lang": "en",
        "string": "tomorrow"
      },
      "priority": 1,
      "child_order": 1,
      "order_key": "a1V",
      "content": "Buy milk",
      "description": "Pick up organic milk",
      "day_order": 1,
      "completed_count": 3,
      "postponed_count": 1
    }
  ],
  "sections": [
    {
      "id": "6fFPHV272WWh3gpW",
      "user_id": "1234567",
      "project_id": "6XGgm6PHrGgMpCFX",
      "added_at": "2025-01-15T10:30:00Z",
      "updated_at": "2025-01-16T10:30:00Z",
      "archived_at": "2025-01-17T10:30:00Z",
      "name": "Groceries",
      "description": "Tasks for the launch plan",
      "section_order": 1,
      "order_key": "a1V"
    }
  ],
  "comments": [
    {
      "id": "6XGgmFQrx44wfGHr",
      "posted_uid": "1234567",
      "content": "Looks good to me.",
      "uids_to_notify": [
        "1234567"
      ],
      "posted_at": "2025-01-15T10:30:00Z",
      "reactions": {
        "👍": [
          "1234567"
        ]
      }
    }
  ],
  "collaborators": [
    {
      "email": "ada@example.com",
      "full_name": "Ada Lovelace",
      "id": "123456",
      "is_deleted": false,
      "timezone": "Europe/London"
    }
  ],
  "collaborator_states": [
    {
      "is_deleted": false,
      "project_id": "6XGgff2vcGGQCQvj",
      "state": "active",
      "user_id": "2671355"
    }
  ],
  "folder": {
    "workspace_id": "123456",
    "name": "Design",
    "id": "1234",
    "default_order": 1,
    "child_order": 1
  },
  "subprojects": [
    {
      "id": "6XGgm6PHrGgMpCFX",
      "can_assign_tasks": true,
      "can_comment": true,
      "child_order": 1,
      "order_key": "a0",
      "color": "charcoal",
      "creator_uid": "1234567",
      "created_at": "2025-01-15T10:30:00Z",
      "name": "Inbox",
      "updated_at": "2025-01-16T10:30:00Z",
      "view_style": "list",
      "default_order": 1,
      "description": "Tasks for the launch plan",
      "public_key": "550e8400-e29b-41d4-a716-446655440000",
      "access": {
        "configuration": {
          "hide_collaborator_details": true,
          "disable_duplication": true
        }
      },
      "role": "admin",
      "parent_id": "6XGgm6PHrGgMpCFX"
    }
  ]
}