Search Agencies

Finds the agencies that match the search criteria.

Resource Information

Scopeagencies

Deprecated scope name:   search_agencies

App TypeAll
Authorization TypeNo authorization required
URI /v4/search/agencies?lang={lang}
HTTP MethodPOST
Automation Version(s)All

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
latitudelatitude{}No The angular distance of a place north or south of the earth's equator, usually expressed in degrees and minutes.All
longitudelongitude{}No The angular distance of a place east or west of the meridian at Greenwich, England, usually expressed in degrees and minutes.All
langStringNo Indicates the language applied.All
stateStringNo Filters the agencies by state. For US and Canada, specify the two-character state portion of the ISO-3661-2 code. For example, "CA" for California and "AB" for Alberta. See https://en.wikipedia.org/wiki/ISO_3166-2:US or https://en.wikipedia.org/wiki/ISO_3166-2:CA for a list of valid codes. For other countries, specify the state name, as configured on Construct Admin Portal > Agencies > Agency Info. All
countryStringNo Filters the agencies by country, as configured on Construct Admin Portal > Agencies > Agency Info. Specify the standard ISO-3661-2 country code. See https://en.wikipedia.org/wiki/ISO_3166-2 for a list of valid codes.All

Response Information

FieldTypeDescriptionAutomation Version
result[]result{}The department agencyAll
result.displayNamestringThe display name of the agency.All
result.enabledbooleanIndicates whether or not the agency is enabled.All
result.hostedACAbooleanIndicates whether or not the agency is hosted on Accela Citizen Access which allows the public to view documents. true : Public users can view documentsAll
result.iconNamestringThe icon filename.All
result.isForDemobooleanIndicates whether or not the agency is used for demo purposes only.All
result.namestringThe full name for the application contact.All
result.serviceProviderCodestringThe unique agency identifier, the system assigns, on the Accela Civic Platform.All
result.statestringThe two-character code for the state that the agency belongs to, as configured on Construct Admin Portal > Agencies > Agency Info. All
result.countrystringThe two-character code for the country that the agency belongs to, as configured on Construct Admin Portal > Agencies > Agency Info. All
statusintegerThe return status.All