Finds the agencies that match the search criteria.
| Scope | agencies Deprecated scope name: search_agencies |
| App Type | All |
| Authorization Type | No authorization required |
| URI | /v4/search/agencies?lang={lang} |
| HTTP Method | POST |
| Automation Version(s) | All |
| Field or Parameter | Type | Required | Values | Description | Automation Version |
|---|---|---|---|---|---|
| latitude | latitude{} | No | � | The angular distance of a place north or south of the earth's equator, usually expressed in degrees and minutes. | All |
| longitude | longitude{} | No | � | The angular distance of a place east or west of the meridian at Greenwich, England, usually expressed in degrees and minutes. | All |
| lang | String | No | � | Indicates the language applied. | All |
| state | String | No | � | 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 |
| country | String | No | � | 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 |
| Field | Type | Description | Automation Version |
|---|---|---|---|
| result[] | result{} | The department agency | All |
| result.displayName | string | The display name of the agency. | All |
| result.enabled | boolean | Indicates whether or not the agency is enabled. | All |
| result.hostedACA | boolean | Indicates whether or not the agency is hosted on Accela Citizen Access which allows the public to view documents. true : Public users can view documents | All |
| result.iconName | string | The icon filename. | All |
| result.isForDemo | boolean | Indicates whether or not the agency is used for demo purposes only. | All |
| result.name | string | The full name for the application contact. | All |
| result.serviceProviderCode | string | The unique agency identifier, the system assigns, on the Accela Civic Platform. | All |
| result.state | string | The two-character code for the state that the agency belongs to, as configured on Construct Admin Portal > Agencies > Agency Info. | All |
| result.country | string | The two-character code for the country that the agency belongs to, as configured on Construct Admin Portal > Agencies > Agency Info. | All |
| status | integer | The return status. | All |