Fetching Data
Agencies
Agencies
When external API clients have user access enabled they also needed access to agency information. To be able to move a user between agencies a list of available agencies is needed.
Fetch available agencies
Fetch list of agencies. If agency group is set to share access to all projects, all agency group agencies will be returned. If not, only agencies user has been given acces to in group will be returned.
If agency is part of a profile group where global access is enabled, an optional parameter to include all profile group agencies can also be specified.
A profile group is a top level group of agencies sharing the same profile, product settings and templates across agency groups. Usually used when agencies are grouped by district, but still share the same profile
URI: https://<im4>/agencies?include_profile_group={include_profile_group?}
- Request-type:
GET - Parameters:
{include_profile_group}(boolean): Include agencies available from profile group - Return data
{mixed}(JSON)