DOdomain
Agents

Retrieves a specific agent details, including contact information.

get/v1/agents/{id}

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.

Path parameters

idinteger required

Agent identifier

Response

OK

dateUpdatedstring date-time nullable

Gets or Sets DateUpdated

agencyIdinteger nullable

Gets or Sets AgencyId

agentIdinteger nullable

Gets or Sets AgentId

emailstring nullable

Gets or Sets Email

firstNamestring nullable

Gets or Sets FirstName

mobilestring nullable

Gets or Sets Mobile

photostring nullable

Gets or Sets Photo

lastNamestring nullable

Gets or Sets LastName

isActiveProfilePagestring nullable

Gets or Sets IsActiveProfilePage

phonestring nullable

Gets or Sets Phone

saleActiveboolean nullable

Gets or Sets SaleActive

rentalActiveboolean nullable

Gets or Sets RentalActive

secondaryEmailstring nullable

Gets or Sets SecondaryEmail

facebookUrlstring nullable

Gets or Sets FacebookUrl

twitterUrlstring nullable

Gets or Sets TwitterUrl

agentVideostring nullable

Gets or Sets AgentVideo

profileTextstring nullable

Gets or Sets ProfileText

isHideSoldLeasedListingsboolean nullable

Gets or Sets IsHideSoldLeasedListings

googlePlusUrlstring nullable

Gets or Sets GooglePlusUrl

personalWebsiteUrlstring nullable

Gets or Sets PersonalWebsiteUrl

linkedInUrlstring nullable

Gets or Sets LinkedInUrl

faxstring nullable

Gets or Sets Fax

mugShotURLstring nullable

Gets or Sets MugShotURL

mugShotNewstring nullable

Gets or Sets MugShotNew

contactTypeCodeinteger nullable

Gets or Sets ContactTypeCode

receivesRequestsboolean nullable

Gets or Sets ReceivesRequests

creAgentVideoURLstring nullable

Gets or Sets CreAgentVideoURL

receiveScheduledReportEmailboolean nullable

Gets or Sets ReceiveScheduledReportEmail

profileUrlstring nullable

Gets or Sets ProfileUrl

jobPositionstring nullable

Gets or Sets JobPosition

Changes

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