DOdomain
Agents

Search for agents by name.

The returned Agent ID can be used to get an agent details by ID. See GET /agents/{id}/

get/v1/agents/search

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

querystring required

The name, or portion of name, to search for.

pageNumberinteger

Page number for paginated results

pageSizeinteger

Page size for paginated results (maximum 20)

Response

OK

agentIdinteger
namestring
agencyNamestring
suburbstring
statestring
profileUrlstring
thumbnailstring

Changes

No recorded changes to this operation across all 18 revisions of this API.