Sign in

v1

latestOpenAPI 3.0.42026-08-04108409993.8 KB
Agencies

Retrieves a specific agency details.

get/v1/agencies/{id}

Path parameters

idinteger required

Agency identifier

Response

OK

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

Gets or Sets AccountType

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

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