API Documentation

API Endpoint

Project Assignments

Project Assignments

Supported filter params

  • project_id (array)

  • person_id (array)

GET /api/v2/project_assignments
Requestsreturns project assignments

GET  /api/v2/project_assignments?filter[project_id]=220

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": [
    {
      "id": "242",
      "type": "project_assignments",
      "attributes": {
        "default_filter_id": null,
        "tasks_layout_id": null,
        "created_at": "2020-08-11T01:05:15.000+02:00",
        "preferences": null,
        "progress_reports_filter_id": null,
        "task_time_reports_filter_id": null,
        "watched": true
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 500
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "1152"
          }
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "220"
          }
        },
        "favorite_filter": {
          "data": null
        },
        "progress_reports_favorite_filter": {
          "data": null
        },
        "task_time_reports_favorite_filter": {
          "data": null
        }
      }
    },
    {
      "id": "243",
      "type": "project_assignments",
      "attributes": {
        "default_filter_id": null,
        "tasks_layout_id": null,
        "created_at": "2020-08-11T01:05:15.000+02:00",
        "preferences": null,
        "progress_reports_filter_id": null,
        "task_time_reports_filter_id": null,
        "watched": null
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 500
          }
        },
        "person": {
          "data": {
            "type": "people",
            "id": "1151"
          }
        },
        "project": {
          "data": {
            "type": "projects",
            "id": "220"
          }
        },
        "favorite_filter": {
          "data": null
        },
        "progress_reports_favorite_filter": {
          "data": null
        },
        "task_time_reports_favorite_filter": {
          "data": null
        }
      }
    }
  ],
  "included": [
    {
      "id": "1152",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1111@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2020-08-11T01:05:15.000+02:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-08-11T01:05:15.698+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 500
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1539"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "220",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": 1,
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": null,
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "board_count": 0,
        "budget_count": 0,
        "worked_time": 0,
        "estimated_time": 0,
        "profit_margin": 0,
        "budget_closing_date": null,
        "invoice_payment_due": null,
        "custom_fields": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "pending_invoicing": 0,
        "pending_invoicing_default": 0,
        "pending_invoicing_normalized": 0,
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 500
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1540"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "1152"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "1151",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1110@email.com",
        "title": null,
        "joined_at": "2020-08-11T01:05:15.000+02:00",
        "last_seen_at": "2020-08-11T01:05:15.777+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-08-11T01:05:15.674+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 500
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1538"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1539",
      "type": "companies",
      "attributes": {
        "name": "Client1040",
        "default_currency": null,
        "created_at": "2020-08-11T01:05:15.694+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 500
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1540",
      "type": "companies",
      "attributes": {
        "name": "Client1041",
        "default_currency": null,
        "created_at": "2020-08-11T01:05:15.716+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 500
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1538",
      "type": "companies",
      "attributes": {
        "name": "Organization500",
        "default_currency": "USD",
        "created_at": "2020-08-11T01:05:15.673+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 500
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "links": {
    "first": "http://www.example.com/api/v2/project_assignments?filter%5Bproject_id%5D=220&page%5Bnumber%5D=1&page%5Bsize%5D=30",
    "last": "http://www.example.com/api/v2/project_assignments?filter%5Bproject_id%5D=220&page%5Bnumber%5D=1&page%5Bsize%5D=30"
  },
  "meta": {
    "current_page": 1,
    "total_pages": 1,
    "total_count": 2,
    "page_size": 30,
    "max_page_size": 200,
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      }
    }
  }
}

Get project assignments
GET/api/v2/project_assignments


GET /api/v2/project_assignments/1
Requestsreturns project assignment

GET  /api/v2/project_assignments/245

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "245",
    "type": "project_assignments",
    "attributes": {
      "default_filter_id": null,
      "tasks_layout_id": null,
      "created_at": "2020-08-11T01:05:15.000+02:00",
      "preferences": null,
      "progress_reports_filter_id": null,
      "task_time_reports_filter_id": null,
      "watched": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 501
        }
      },
      "person": {
        "data": {
          "type": "people",
          "id": "1154"
        }
      },
      "project": {
        "data": {
          "type": "projects",
          "id": "221"
        }
      },
      "favorite_filter": {
        "data": null
      },
      "progress_reports_favorite_filter": {
        "data": null
      },
      "task_time_reports_favorite_filter": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "1154",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1113@email.com",
        "title": null,
        "joined_at": "2020-08-11T01:05:15.000+02:00",
        "last_seen_at": "2020-08-11T01:05:15.983+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-08-11T01:05:15.885+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 501
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1542"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "221",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": 1,
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": null,
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "board_count": 0,
        "budget_count": 0,
        "worked_time": 0,
        "estimated_time": 0,
        "profit_margin": 0,
        "budget_closing_date": null,
        "invoice_payment_due": null,
        "custom_fields": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "pending_invoicing": 0,
        "pending_invoicing_default": 0,
        "pending_invoicing_normalized": 0,
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 501
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1544"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "1155"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "1542",
      "type": "companies",
      "attributes": {
        "name": "Organization501",
        "default_currency": "USD",
        "created_at": "2020-08-11T01:05:15.883+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 501
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1544",
      "type": "companies",
      "attributes": {
        "name": "Client1044",
        "default_currency": null,
        "created_at": "2020-08-11T01:05:15.926+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 501
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1155",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1114@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2020-08-11T01:05:15.000+02:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-08-11T01:05:15.908+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 501
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1543"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1543",
      "type": "companies",
      "attributes": {
        "name": "Client1043",
        "default_currency": null,
        "created_at": "2020-08-11T01:05:15.904+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 501
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      }
    }
  }
}

Gets a project assignment
GET/api/v2/project_assignments/{id}

URI Parameters
HideShow
id
number (required) Example: 1

project assignment id


POST /api/v2/project_assignments
Requestscreates project assignmentreturns errorreturns error

POST  /api/v2/project_assignments

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "project_assignments",
    "attributes": {},
    "relationships": {
      "project": {
        "data": {
          "type": "projects",
          "id": "222"
        }
      },
      "person": {
        "data": {
          "type": "people",
          "id": "1159"
        }
      }
    }
  }
}
Responses201
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "248",
    "type": "project_assignments",
    "attributes": {
      "default_filter_id": null,
      "tasks_layout_id": null,
      "created_at": "2020-08-11T01:05:16.000+02:00",
      "preferences": null,
      "progress_reports_filter_id": null,
      "task_time_reports_filter_id": null,
      "watched": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 502
        }
      },
      "person": {
        "data": {
          "type": "people",
          "id": "1159"
        }
      },
      "project": {
        "data": {
          "type": "projects",
          "id": "222"
        }
      },
      "favorite_filter": {
        "data": null
      },
      "progress_reports_favorite_filter": {
        "data": null
      },
      "task_time_reports_favorite_filter": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "1159",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1118@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2020-08-11T01:05:16.000+02:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-08-11T01:05:16.131+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 502
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1549"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "222",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": 1,
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": null,
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "board_count": 0,
        "budget_count": 0,
        "worked_time": 0,
        "estimated_time": 0,
        "profit_margin": 0,
        "budget_closing_date": null,
        "invoice_payment_due": null,
        "custom_fields": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "pending_invoicing": 0,
        "pending_invoicing_default": 0,
        "pending_invoicing_normalized": 0,
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 502
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1548"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "1158"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "1549",
      "type": "companies",
      "attributes": {
        "name": "Client1048",
        "default_currency": null,
        "created_at": "2020-08-11T01:05:16.127+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 502
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1548",
      "type": "companies",
      "attributes": {
        "name": "Client1047",
        "default_currency": null,
        "created_at": "2020-08-11T01:05:16.104+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 502
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1158",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1117@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2020-08-11T01:05:16.000+02:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-08-11T01:05:16.086+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 502
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1547"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1547",
      "type": "companies",
      "attributes": {
        "name": "Client1046",
        "default_currency": null,
        "created_at": "2020-08-11T01:05:16.082+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 502
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      }
    }
  }
}

POST  /api/v2/project_assignments

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "project_assignments",
    "attributes": {},
    "relationships": {
      "project": {
        "data": {
          "type": "projects",
          "id": "0"
        }
      },
      "person": {
        "data": {
          "type": "people",
          "id": "1162"
        }
      }
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "attribute is invalid",
      "source": {
        "pointer": "data/attributes/project"
      }
    }
  ]
}

POST  /api/v2/project_assignments

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "project_assignments",
    "attributes": {},
    "relationships": {
      "project": {
        "data": {
          "type": "projects",
          "id": "225"
        }
      },
      "person": {
        "data": {
          "type": "people",
          "id": "1166"
        }
      }
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "has already been assigned to that project",
      "source": {
        "pointer": "data/attributes/person"
      }
    }
  ]
}

Create a project assignment
POST/api/v2/project_assignments


PATCH /api/v2/project_assignments/1
Requestsupdates project assignmentreturns errorreturns error

PATCH  /api/v2/project_assignments/258

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "project_assignments",
    "attributes": {
      "default_filter_id": 3
    }
  }
}
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "258",
    "type": "project_assignments",
    "attributes": {
      "default_filter_id": 3,
      "tasks_layout_id": null,
      "created_at": "2020-08-11T01:05:16.000+02:00",
      "preferences": null,
      "progress_reports_filter_id": null,
      "task_time_reports_filter_id": null,
      "watched": null
    },
    "relationships": {
      "organization": {
        "data": {
          "type": "organizations",
          "id": 507
        }
      },
      "person": {
        "data": {
          "type": "people",
          "id": "1172"
        }
      },
      "project": {
        "data": {
          "type": "projects",
          "id": "227"
        }
      },
      "favorite_filter": {
        "data": null
      },
      "progress_reports_favorite_filter": {
        "data": null
      },
      "task_time_reports_favorite_filter": {
        "data": null
      }
    }
  },
  "included": [
    {
      "id": "1172",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1130@email.com",
        "title": null,
        "joined_at": "2020-08-11T01:05:16.000+02:00",
        "last_seen_at": "2020-08-11T01:05:16.900+02:00",
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 1,
        "invited_at": null,
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-08-11T01:05:16.786+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 507
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1565"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "227",
      "type": "projects",
      "attributes": {
        "name": "test project",
        "number": 1,
        "project_type_id": 2,
        "project_color_id": null,
        "last_activity_at": null,
        "public_access": true,
        "time_on_tasks": false,
        "tag_colors": {},
        "archived_at": null,
        "board_count": 0,
        "budget_count": 0,
        "worked_time": 0,
        "estimated_time": 0,
        "profit_margin": 0,
        "budget_closing_date": null,
        "invoice_payment_due": null,
        "custom_fields": null,
        "currency": "USD",
        "currency_default": "USD",
        "currency_normalized": "USD",
        "revenue": 0,
        "revenue_default": 0,
        "revenue_normalized": 0,
        "cost": 0,
        "cost_default": 0,
        "cost_normalized": 0,
        "profit": 0,
        "profit_default": 0,
        "profit_normalized": 0,
        "pending_invoicing": 0,
        "pending_invoicing_default": 0,
        "pending_invoicing_normalized": 0,
        "needs_invoicing": 0,
        "needs_invoicing_default": 0,
        "needs_invoicing_normalized": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 507
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1567"
          }
        },
        "project_manager": {
          "data": {
            "type": "people",
            "id": "1173"
          }
        },
        "last_actor": {
          "data": null
        }
      }
    },
    {
      "id": "1565",
      "type": "companies",
      "attributes": {
        "name": "Organization507",
        "default_currency": "USD",
        "created_at": "2020-08-11T01:05:16.785+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 507
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1567",
      "type": "companies",
      "attributes": {
        "name": "Client1061",
        "default_currency": null,
        "created_at": "2020-08-11T01:05:16.826+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 507
          }
        },
        "bill_to": {
          "data": null
        }
      }
    },
    {
      "id": "1173",
      "type": "people",
      "attributes": {
        "first_name": "test first name",
        "last_name": "test last name",
        "email": "user1131@email.com",
        "title": null,
        "joined_at": null,
        "last_seen_at": null,
        "deactivated_at": null,
        "archived_at": null,
        "role_id": 3,
        "invited_at": "2020-08-11T01:05:16.000+02:00",
        "is_user": true,
        "tag_list": [],
        "avatar_url": null,
        "virtual": false,
        "custom_fields": null,
        "autotracking": false,
        "created_at": "2020-08-11T01:05:16.809+02:00",
        "placeholder": false,
        "color_id": null,
        "private_custom_reports_used": 0
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 507
          }
        },
        "company": {
          "data": {
            "type": "companies",
            "id": "1566"
          }
        },
        "subsidiary": {
          "data": null
        }
      }
    },
    {
      "id": "1566",
      "type": "companies",
      "attributes": {
        "name": "Client1060",
        "default_currency": null,
        "created_at": "2020-08-11T01:05:16.805+02:00",
        "archived_at": null,
        "avatar_url": null,
        "invoice_email_recipients": {},
        "custom_fields": null,
        "description": null,
        "due_days": null,
        "tag_list": []
      },
      "relationships": {
        "organization": {
          "data": {
            "type": "organizations",
            "id": 507
          }
        },
        "bill_to": {
          "data": null
        }
      }
    }
  ],
  "meta": {
    "organization_features": {
      "custom_fields": {
        "type": "metered",
        "limit": 15,
        "used": 0
      },
      "custom_fields_per_project": {
        "type": "metered",
        "limit": 10,
        "used": 0
      },
      "public_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "private_custom_reports": {
        "type": "metered",
        "limit": 30,
        "used": 0
      },
      "scheduling_placeholders": {
        "type": "metered",
        "limit": 5,
        "used": 0
      },
      "multigrouping": {
        "type": "switch",
        "available": true
      },
      "client_access_to_budgets": {
        "type": "switch",
        "available": true
      },
      "subsidiaries": {
        "type": "switch",
        "available": true
      },
      "time_approvals": {
        "type": "switch",
        "available": true
      },
      "expenses_approvals": {
        "type": "switch",
        "available": true
      },
      "timeoff_approvals": {
        "type": "switch",
        "available": true
      },
      "autotracking": {
        "type": "switch",
        "available": true
      },
      "forecasting": {
        "type": "switch",
        "available": true
      },
      "webhooks": {
        "type": "switch",
        "available": true
      },
      "table_pivoting": {
        "type": "switch",
        "available": true
      },
      "formula_fields": {
        "type": "switch",
        "available": true
      },
      "single_sign_on": {
        "type": "switch",
        "available": true
      }
    }
  }
}

PATCH  /api/v2/project_assignments/276

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "project_assignments",
    "attributes": {},
    "relationships": {
      "project": {
        "data": {
          "type": "projects",
          "id": "0"
        }
      }
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "attribute is invalid",
      "source": {
        "pointer": "data/attributes/project"
      }
    }
  ]
}

PATCH  /api/v2/project_assignments/278

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "project_assignments",
    "attributes": {},
    "relationships": {
      "project": {
        "data": {
          "type": "projects",
          "id": "242"
        }
      }
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "has already been assigned to that project",
      "source": {
        "pointer": "data/attributes/person"
      }
    }
  ]
}

Update a project assignment
PATCH/api/v2/project_assignments/{id}

URI Parameters
HideShow
id
number (required) Example: 1

project assignment id


DELETE /api/v2/project_assignments/1
Requestsdeletes assignment

DELETE  /api/v2/project_assignments/282

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses204
This response has no content.

Deletes a project assignment
DELETE/api/v2/project_assignments/{id}

URI Parameters
HideShow
id
number (required) Example: 1

project assignment id


Generated by aglio on 10 Aug 2020