MImiddesk
reviews

Retrieve a review for a business

Changed on

Returns the review associated with a business

get/v1/businesses/{business_id}/review

Request

  • Base URL
    https://api.middesk.com
  • Auth
    HTTP bearer

Path parameters

business_idstring required

Business ID

Response

review found

object'review' required
idstring uuid required
created_atstring date-time required
updated_atstring date-time required
completed_atstring date-time nullable
analyst_read_markdownstring nullable

LLM-generated analyst read of the business's verification results, in CommonMark markdown: one lead sentence followed by up to five bullet findings. Inline links, when present, are dashboard-relative paths (for example /businesses/{id}/registrations) and may be ignored by API consumers. Null until a read has been generated; generated only for businesses without a risk order, whose risk assessment carries its own read.

analyst_read_generated_atstring date-time nullable

When the analyst read was delivered. Null until a read has been generated.

Changes

  • a32370f9357eRevision changes
    • warning

      added the new People NPI Match enum value to the // response property for the response status

    • warning

      added the new person_npi_match enum value to the // response property for the response status

  • 4c9cd4e834baRevision changes
    • breaking

      added to the response property oneOf list for the response status

    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security bearer_auth was added to the API

    • info

      removed from the response property oneOf list for the response status