Skip to content
Brooklyn Solutions Developers

Reviews

Reviews: governance meetings with a vendor or committee, with agenda, attendees, scoring and minutes.

Loading a list with search, filters and paging? Use Reviews — list screen: the filters go in the request body.

Base path
/reviews

Endpoints

40 endpoints

Method

Standard Operations

7
  • GET /reviews List reviews (with search, filters and paging).
  • POST /reviews Create a new review.
  • PATCH /reviews/bulk Update several reviews at once.
  • GET /reviews/{id} Open a single review.
  • PUT /reviews/{id} Replace a review's details in full.
  • PATCH /reviews/{id} Edit a review.
  • DELETE /reviews/{id} Delete a review.

Additional Operations

33
  • GET /reviews/{reviewId}/files List documents attached to a review.
  • GET /reviews/{reviewId}/files/{type} List a review's documents of a given type (e.g. minutes).
  • GET /reviews/account/{id}/open List open reviews for the account.
  • GET /reviews/{reviewId}/categories List the checklist categories in a review.
  • GET /reviews/{reviewId}/category/{categoryId}/checkpoints List the checkpoints in one category of a review.
  • POST /reviews/{reviewId}/category/{categoryId}/checkpoints Add checkpoints to a category in a review.
  • POST /reviews/{reviewId}/checkpoint/{checkpointId}/itemreviews Add a review item (finding or action) under a checkpoint.
  • PATCH /reviews/{reviewId}/checkpoint/{checkpointId} Update a checkpoint in a review (e.g. its score).
  • PATCH /reviews/{reviewId}/checkpoints/{checkpointId} Update a checkpoint in a review.
  • DELETE /reviews/{reviewId}/checkpoints/{checkpointId} Remove a checkpoint from a review.
  • GET /reviews/{id}/meetingitems List the agenda items for a review meeting.
  • GET /reviews/account/{id}/addcheckpoints List checkpoints that can be added to reviews.
  • POST /reviews/{reviewId}/clone Copy a review to create the next meeting.
  • POST /reviews/addcheckpoints Add checkpoints to a review.
  • DELETE /reviews/{reviewId}/addcheckpoints Remove added checkpoints from a review.
  • GET /reviews/last Show the most recent review.
  • GET /reviews/{reviewId}/itemreviews List the review items in a review.
  • GET /reviews/{reviewId}/itemreviews/scores Show the scores given in a review.
  • GET /reviews/{reviewId}/info Show summary information about a review.
  • GET /reviews/{reviewId}/contract Show the contract a review belongs to.
  • GET /reviews/account/{id} List reviews for the account.
  • GET /reviews/{id}/attendees List who is attending a review.
  • PATCH /reviews/{id}/attendees Change who is attending a review.
  • GET /reviews/{id}/allowed-attendees List who is allowed to attend a review.
  • GET /reviews/{reviewId}/ics Download a calendar invite for a review.
  • PATCH /reviews/{reviewId}/apologies/{userId} Record that someone sent apologies for a review.
  • PATCH /reviews/{reviewId}/informed/{userId} Record that someone should be kept informed about a review.
  • GET /reviews/timeline Show reviews on a timeline by date.
  • GET /reviews/scores Show review scores across reviews.
  • POST /reviews/{id}/share Share a review's agenda or minutes by email.
  • GET /reviews/past-reviews-empty-meeting-minutes Find past reviews with no minutes written yet.
  • GET /reviews/category-checkpoint-list List every category with its checkpoints.
  • GET /reviews/next-review-committee Show a committee's next scheduled review.