DOdomain
Agents

Retrieves the overall star ratings and number of reviews for a list of agents by their ids.

Changed on

A maximum of 50 ids is allowed.

get/v2/agents/reviews

Request

  • Base URL
    https://api.domain.com.au
  • Auth
    • API key in header x-api-key
    • or OAuth 2
      Authorization codehttps://auth.domain.com.au/v1/connect/authorize
      Client credentials
      Token URLhttps://auth.domain.com.au/v1/connect/token
      Scopesapi_agencies_read
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

idsinteger[]

Comma-separated list of agent unique identifiers (up to 50).

Response

Review ratings for the provided agent ids

agentIdinteger nullable

Gets or Sets AgentId

overallStarRatingnumber double nullable

Gets or Sets OverallStarRating

overallStarRatingRecentnumber double nullable

Gets or Sets OverallStarRatingRecent

numberOfReviewsinteger nullable

Gets or Sets NumberOfReviews

numberOfReviewsRecentinteger nullable

Gets or Sets NumberOfReviewsRecent

Changes