Gets the API runtime environments for the specified agency, including the environment's API provider and version. The environments are configured on Construct Admin Portal > Agencies > {agencyHost}:AgencyInfo > Environments.
Scope | agencies Deprecated scope name: get_agency_environments |
App Type | All |
Authorization Type | No authorization required |
URI | /v4/agencies/{name}/environments |
HTTP Method | GET |
Automation Version(s) | All |
Field or Parameter | Type | Required | Values | Description | Automation Version |
---|---|---|---|---|---|
name | string | Yes | � | The name of the agency. | All |
Field | Type | Description | Automation Version |
---|---|---|---|
result[] | result{} | An array containing the environments for the requested agency. | All |
result.name | string | The name of an agency's API runtime environment, as configured on Construct Admin Portal > Agencies > {agencyHost}:AgencyInfo > Environments. | All |
result.product | string | The API provider product, such as "AA" for (Civic Platform) Automation. | All |
result.version | string | The version of the API provider product, as specified on Construct Admin Portal > Agencies > {agencyHost}:AgencyInfo > Environments. | All |
status | integer | The return status. | All |