Join

Retrieve the total estimated cost of a Join project's active milestone, along with a breakdown of that total by cost category.

project-costs

Get a Join project's metrics per milestone. Metrics are the project's enabled units of measure, such as GSF or beds, and each milestone records a quantity for some of them. A metric with no row at a milestone has no quantity entered there, which is not the same as zero.

metrics-for-project

Get the labels a Join project uses for its cost concepts, keyed by concept. A project can rename these concepts, and Join shows the renamed labels throughout that project. This server's other tools use the default labels. The concepts, with their default labels: ESTIMATE (Estimate) is the milestone's baseline estimate; items are changes relative to it. TARGET (Budget) is the target budget for the project. DELTA (Delta) is the budget minus the estimate: negative when the estimate is over budget, positive when under. RUNNING_TOTAL (Running Total) is the estimate plus accepted items, the project's current cost. GAP (Gap) is the budget minus the running total, the change still needed to meet the budget. DIRECT_COST (Direct Costs) is the cost of materials, labor, equipment, and similar, before markups. MARKUP (Markups) is indirect, below-the-line costs. COST_OF_CONSTRUCTION (Cost of Construction) is all project costs except owner costs. PROJECT_TOTAL (Project Total) is all project costs, including owner costs. PROJECT_RUNNING_TOTAL (Project Running Total) is the running total including owner costs.

terminology-for-project

Return the scheduled activities that make up a Join project's timeline. The dependencies between activities are returned alongside them. Results are paginated.

timeline-for-project

Get a single risk recorded on a Join project by its ID. Risk IDs are returned by `risks-for-project`.

get-risk

List saved benchmarking reports, which compare cost and scope metrics across several Join projects, optionally filtered to those attached to one project. These, together with the reports saved on individual projects, are what users are referring to by "my reports" or "reports in Join". Each report includes a `url` linking to it in the Join web app. Reports saved against a single project are listed by `list-user-reports`.

list-benchmarking-reports

List the files attached to a Join item or option, covering both those uploaded to Join and those linked from an external document system such as Procore, Autodesk, or Egnyte. File contents are not returned. Results are paginated. Item IDs are returned by `items-for-project`, and `get-item` reports how many assets an item has.

assets-for-item

List the discussion recorded on a Join item or option, oldest first. Results are paginated. Item IDs are returned by `items-for-project`, and `get-item` reports how many comments an item has.

comments-for-item

List the categorizations enabled on this Join project. Categorizations are the labeling schemes, such as trade, system, or building area, used to group and break down a project's estimate lines, items, or risks. PAGE output returns a page of categorizations with example categories. RESOURCE output stores every category of the project's categorizations, except the built-in MasterFormat and UniFormat, as a JSON table to download.

categorizations-for-project

List the people collaborating on a Join project. Results are paginated.

collaborators-for-project

List the companies working on a Join project. Results are paginated.

companies-for-project

List the images a report about a Join project can use: the project's thumbnail, its print header, the logos of its owner, design team, and general contractor, and the logos of the companies on the project. Each image is identified by asset ID, and `get-asset` returns the file. `printHeader` lists what Join's own printed reports show in their header: the print header when the project has one, otherwise the team logos. A project that shows one of Join's default icons has no thumbnail entry.

images-for-project

List the items and options in a Join project as of its active milestone by default. Results can be filtered, sorted, scoped to another milestone or to all milestones, and can include drafts. Items are the individual scope decisions tracked on a project. A visibility of PUBLISHED means the item is not a draft. Results are paginated. The item IDs it returns are the input to `get-item`, which carries an item's full detail.

items-for-project

List the milestones of a Join project, optionally including drafts. Milestones correspond to new design and estimate issuances on the project. Results are paginated. Items and most cost reports are scoped to these milestoneIDs, and the activeMilestoneID is treated as the default.

milestones-for-project

List the reports saved against a single Join project, including milestone cost reports, variance reports, and other custom reports. These, together with benchmarking reports, are what users are referring to by "my reports" or "reports in Join". Reports are scoped to one project, and project IDs are returned by `list-my-projects`. Each report includes a `url` linking to it in the Join web app. Benchmarking reports that compare several projects are listed in full by `list-benchmarking-reports`.

list-user-reports

List the risks of a given type recorded on a Join project. Results are paginated.

risks-for-project

List the project types a new project can be filed under, for the company the authenticated user belongs to. Join scopes project types to a company and groups them into categories, so two types can share a name under different categories and only the ID identifies one; that ID is what create-project's `typeID` argument takes.

list-project-types

List the construction projects in Join that the authenticated user is a member of (`my`) or that belong to their company (`all`). Each project includes a `url` linking to it in the Join web app. Results are paginated. The project IDs it returns are the input to the other project tools.

list-my-projects

Keyword search over the items in the Join projects in scope, ranked by relevance. The query matches an item's number, name, and description, and the names of its categories, milestone, and project. PAGE output returns a page of matches in relevance order. RESOURCE output stores every match, up to 9,500, as JSON to download. Item IDs returned here are accepted by `get-item`.

search-items

Keyword search over the Join projects in scope, most recently updated first unless sortKey says otherwise. PAGE output returns a page of matches. RESOURCE output stores every match, up to 9,500, as JSON to download. The project IDs it returns are the input to the other project tools.

search-projects

Update an existing Join item or option by ID. Omitted or empty arguments leave their field unchanged; a value is removed only through its clear flag. Supply at least one field or clear flag. Calls are idempotent, and the result names what actually changed alongside the item's stored values. A failed call can leave some fields already changed, and the error names them. The API rejects some status changes: an item with options moves only between ACCEPTED and INCORPORATED or among PENDING, REJECTED and NOTAPPLICABLE, and NOTCHOSEN applies only to an option whose parent is ACCEPTED or INCORPORATED.

update-item

Update an existing Join project by ID. The call fails unless the authenticated user may edit the project's details, which is the same permission the web app gates these fields on. Omitted or empty arguments leave their field unchanged; the code is removed only through its clear flag. Supply at least one field or clear flag. Calls are idempotent, and the result names what actually changed alongside the project's stored values. The type is written by an API call of its own, so a failed call can leave some fields already changed, and the error names them; calling again from the same arguments finishes the job, since what is already stored is not written twice. The status is given by name, and the type as an ID from list-project-types.

update-project