DOdomain
Agencies

Retrieves a specific agency details.

get/v1/agencies/{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

Agency identifier

Response

OK

dateUpdatedstring date-time nullable

Gets or Sets DateUpdated

namestring nullable

Gets or Sets Name

idinteger nullable

Gets or Sets Id

creIdinteger nullable

Gets or Sets CreId

accountType'none' | 'residential' | 'commercialLight' | 'commercialFull' | 'developer' | 'holiday' | 'business'

Gets or Sets AccountType

homepassEnabledboolean nullable

Gets or Sets HomepassEnabled

suburbsServedstring nullable

Gets or Sets SuburbsServed

subscribedToAgencyPerformanceReportboolean nullable

Gets or Sets SubscribedToAgencyPerformanceReport

welcomeMessagestring nullable

Gets or Sets WelcomeMessage

adFormatstring nullable

Gets or Sets AdFormat

providerAgencyIdstring nullable

Gets or Sets ProviderAgencyId

Changes

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