---
title: "Add Guest to Project"
method: POST
path: "/api_v2/projects/{project_id}/add_guest.json"
tags: ["Projects"]
---

# Add Guest to Project

`POST /api_v2/projects/{project_id}/add_guest.json`

## Request

- Base URL: `https://www.bugherd.com`
- URL: `https://www.bugherd.com/api_v2/projects/{project_id}/add_guest.json`
- Auth: HTTP basic

Adds a guest to a project. Provide either a `user_id` for an existing user or an `email` to send a new invitation.

## Path parameters

- `project_id` integer, required

## Request body

- object
  - `user_id` integer: ID of an existing user to add as a guest
  - `email` string, email: Alternative to user_id - invite by email address

## Response `200`

Guest added successfully

- object
  - `project` Project
    - `id` integer
    - `name` string
    - `created_at` string: Project creation timestamp
    - `tasks` boolean: Whether the project has any tasks
    - `devurl` string, uri
    - `is_active` boolean
    - `is_public` boolean
    - `has_custom_columns` boolean
    - `guests_see_guests` boolean
    - `owner_name` string
    - `sites` string[]
    - `api_key` string
    - `allow_guests_change_task_status` boolean
    - `assign_guests` boolean
    - `allow_project_summary_email` boolean
    - `allow_task_done_email` boolean
    - `allow_project_owner_notifications` boolean
    - `change_guest_default_column` boolean
    - `members` User[]
      - `id` integer
      - `email` string, email
      - `display_name` string
      - `avatar_url` string, uri
    - `guests` User[]
      - `id` integer
      - `email` string, email
      - `display_name` string
      - `avatar_url` string, uri
    - `columns` Column[]
      - `id` integer
      - `name` string
      - `project_id` integer
      - `position` integer: Display order (0-indexed)
      - `tasks_count` integer
      - `created_at` string, date-time
      - `updated_at` string, date-time

---

[API](https://skmtc.dev/bugherd/apis/bugherd-api-v2.md) · [All operations](https://skmtc.dev/bugherd/apis/bugherd-api-v2/llms.txt) · [OpenAPI document](https://skmtc.dev/bugherd/apis/bugherd-api-v2/revisions/bf473cda70d4?raw)