Get All Agencies

Gets all enabled agencies that are configured on the Construct Admin Portal.

Resource Information

Scope agencies

Deprecated scope name:   get_agencies
App Type All
Authorization Type No authorization required
URI /v4/agencies
HTTP Method GET
Automation Version(s) All

Request Information

Field or Parameter Type Required Values Description Automation Version
limit long No   Indicates the number of items that are returned in each page. All
name string No   The name of the object to be queried. All
offset long No   Indicates the offset start of each page by the number specified. All

Response Information

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 has deployed Citizen Access for the public user. 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