The Project User object

Attributes

id string

Unique identifier for the object.

idx integer
parent_id string required
parent_type string required
user string required
email string
image string
full_name string
welcome_email_sent boolean

Default: false

view_attachments boolean

Default: false

hide_timesheets boolean

Default: false

project_status string
The Project User object 
{
  "id": "project-user_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "user": "user_example",
  "email": "user@example.com",
  "image": "image_example",
  "full_name": "full_name_example",
  "welcome_email_sent": false,
  "view_attachments": false,
  "hide_timesheets": false,
  "project_status": "project_status_example"
}
GET /api/projects/project-user?parent_id={id}

List project users by parent

Returns all project users belonging to the specified parent.

Query parameters

parent_id string required

The ID of the parent to list children for.

Returns

A list of project user objects belonging to the parent.

GET /api/projects/project-user?parent_id={id} 
curl https://api.overplane.dev/api/projects/project-user?parent_id=parent_abc123 \
  -H "Authorization: Bearer sk_test_..."
Response 
{
  "data": [
    {
      "id": "project-user_abc123",
      "idx": 1,
      "parent_id": null,
      "parent_type": "parent_type_example",
      "user": "user_example",
      "email": "user@example.com",
      "image": "image_example",
      "full_name": "full_name_example",
      "welcome_email_sent": false,
      "view_attachments": false,
      "hide_timesheets": false,
      "project_status": "project_status_example"
    }
  ],
  "has_more": false,
  "total": 1
}
POST /api/projects/project-user

Create a project user

Creates a new project user object.

Body parameters

idx integer
parent_id string required
parent_type string required
user string required
email string
image string
full_name string
welcome_email_sent boolean

Default: false

view_attachments boolean

Default: false

hide_timesheets boolean

Default: false

project_status string

Returns

Returns the newly created project user object if the call succeeded.

POST /api/projects/project-user 
curl https://api.overplane.dev/api/projects/project-user \
  -H "Authorization: Bearer sk_test_..." \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"parent_id":null,"parent_type":"parent_type_example","user":"user_example"}'
Response 
{
  "id": "project-user_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "user": "user_example",
  "email": "user@example.com",
  "image": "image_example",
  "full_name": "full_name_example",
  "welcome_email_sent": false,
  "view_attachments": false,
  "hide_timesheets": false,
  "project_status": "project_status_example"
}
PATCH /api/projects/project-user/{id}

Update a project user

Updates the specified project user by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path parameters

id string required

The identifier of the project user to update.

Body parameters

idx integer
parent_id string
parent_type string
user string
email string
image string
full_name string
welcome_email_sent boolean

Default: false

view_attachments boolean

Default: false

hide_timesheets boolean

Default: false

project_status string

Returns

Returns the updated project user object.

PATCH /api/projects/project-user/{id} 
curl https://api.overplane.dev/api/projects/project-user/project-user_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X PATCH \
  -H "Content-Type: application/json" \
  -d '{"idx":1,"parent_id":null}'
Response 
{
  "id": "project-user_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "user": "user_example",
  "email": "user@example.com",
  "image": "image_example",
  "full_name": "full_name_example",
  "welcome_email_sent": false,
  "view_attachments": false,
  "hide_timesheets": false,
  "project_status": "project_status_example"
}
DELETE /api/projects/project-user/{id}

Delete a project user

Permanently deletes a project user. This cannot be undone.

Path parameters

id string required

The identifier of the project user to delete.

Returns

Returns a confirmation that the project user has been deleted.

DELETE /api/projects/project-user/{id} 
curl https://api.overplane.dev/api/projects/project-user/project-user_abc123 \
  -H "Authorization: Bearer sk_test_..." \
  -X DELETE
Response 
{
  "id": "project-user_abc123",
  "deleted": true
}
POST /api/projects/project-user/reorder

Reorder project users

Updates the sort order of project users within their parent by setting new index values.

Returns

Returns the reordered list.

POST /api/projects/project-user/reorder 
curl https://api.overplane.dev/api/projects/project-user/reorder \
  -H "Authorization: Bearer sk_test_..." \
  -X POST
Response 
{
  "id": "project-user_abc123",
  "idx": 1,
  "parent_id": null,
  "parent_type": "parent_type_example",
  "user": "user_example",
  "email": "user@example.com",
  "image": "image_example",
  "full_name": "full_name_example",
  "welcome_email_sent": false,
  "view_attachments": false,
  "hide_timesheets": false,
  "project_status": "project_status_example"
}