GET api/Agencies/FindAgenciesByName/{name}/{lang}/{startIndex}/{count}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
name

string

Required

lang

string

Default value is en

startIndex

Object

None.

count

Object

None.

Body Parameters

None.

Response Information

Resource Description

Collection of ApiProfileViewModel

Response Formats

application/json, text/json

Sample:
[
  {
    "AgencyId": 1,
    "AgencyName": "sample string",
    "FriendlyName": "sample string",
    "AgencyType": "sample string",
    "ServiceCategory": "sample string",
    "Description": "sample string",
    "Acronym": "sample string",
    "LogoUrl": "sample string",
    "LogoUrlWebp": "sample string",
    "WebsiteURL": "sample string",
    "ContactPhone": "sample string",
    "ContactPhoneDisplay": "sample string",
    "ContactPhoneDigits": "sample string",
    "HearingImpairedPhone": "sample string",
    "FaxNumber": "sample string",
    "PhoneHours": "sample string",
    "ContactURL": "sample string",
    "ContactEmail": "sample string",
    "LivechatLink": "sample string",
    "TwitterAccount": "sample string",
    "Facebook": "sample string",
    "YouTube": "sample string",
    "AppleAppStoreUrl": "sample string",
    "GooglePlayStoreUrl": "sample string",
    "InstagramUrl": "sample string",
    "LinkedInUrl": "sample string",
    "NewsFeed": "sample string",
    "Updated": "2026-01-01T00:00:00Z",
    "GssSearchEngineID": "sample string",
    "GaUA_ID": "sample string",
    "ServiceNameTag": "sample string",
    "AgencyTags": "sample string",
    "Keywords": "sample string"
  },
  {
    "AgencyId": 1,
    "AgencyName": "sample string",
    "FriendlyName": "sample string",
    "AgencyType": "sample string",
    "ServiceCategory": "sample string",
    "Description": "sample string",
    "Acronym": "sample string",
    "LogoUrl": "sample string",
    "LogoUrlWebp": "sample string",
    "WebsiteURL": "sample string",
    "ContactPhone": "sample string",
    "ContactPhoneDisplay": "sample string",
    "ContactPhoneDigits": "sample string",
    "HearingImpairedPhone": "sample string",
    "FaxNumber": "sample string",
    "PhoneHours": "sample string",
    "ContactURL": "sample string",
    "ContactEmail": "sample string",
    "LivechatLink": "sample string",
    "TwitterAccount": "sample string",
    "Facebook": "sample string",
    "YouTube": "sample string",
    "AppleAppStoreUrl": "sample string",
    "GooglePlayStoreUrl": "sample string",
    "InstagramUrl": "sample string",
    "LinkedInUrl": "sample string",
    "NewsFeed": "sample string",
    "Updated": "2026-01-01T00:00:00Z",
    "GssSearchEngineID": "sample string",
    "GaUA_ID": "sample string",
    "ServiceNameTag": "sample string",
    "AgencyTags": "sample string",
    "Keywords": "sample string"
  }
]

application/xml, text/xml

Sample:
<ArrayOfApiProfileViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CA.GOV.AgencyProfileApi.Models">
  <ApiProfileViewModel>
    <Acronym>sample string</Acronym>
    <AgencyId>1</AgencyId>
    <AgencyName>sample string</AgencyName>
    <AgencyTags>sample string</AgencyTags>
    <AgencyType>sample string</AgencyType>
    <AppleAppStoreUrl>sample string</AppleAppStoreUrl>
    <ContactEmail>sample string</ContactEmail>
    <ContactPhone>sample string</ContactPhone>
    <ContactPhoneDigits>sample string</ContactPhoneDigits>
    <ContactPhoneDisplay>sample string</ContactPhoneDisplay>
    <ContactURL>sample string</ContactURL>
    <Description>sample string</Description>
    <Facebook>sample string</Facebook>
    <FaxNumber>sample string</FaxNumber>
    <FriendlyName>sample string</FriendlyName>
    <GaUA_ID>sample string</GaUA_ID>
    <GooglePlayStoreUrl>sample string</GooglePlayStoreUrl>
    <GssSearchEngineID>sample string</GssSearchEngineID>
    <HearingImpairedPhone>sample string</HearingImpairedPhone>
    <InstagramUrl>sample string</InstagramUrl>
    <Keywords>sample string</Keywords>
    <LinkedInUrl>sample string</LinkedInUrl>
    <LivechatLink>sample string</LivechatLink>
    <LogoUrl>sample string</LogoUrl>
    <LogoUrlWebp>sample string</LogoUrlWebp>
    <NewsFeed>sample string</NewsFeed>
    <PhoneHours>sample string</PhoneHours>
    <ServiceCategory>sample string</ServiceCategory>
    <ServiceNameTag>sample string</ServiceNameTag>
    <TwitterAccount>sample string</TwitterAccount>
    <Updated>2026-01-01T00:00:00Z</Updated>
    <WebsiteURL>sample string</WebsiteURL>
    <YouTube>sample string</YouTube>
  </ApiProfileViewModel>
  <ApiProfileViewModel>
    <Acronym>sample string</Acronym>
    <AgencyId>1</AgencyId>
    <AgencyName>sample string</AgencyName>
    <AgencyTags>sample string</AgencyTags>
    <AgencyType>sample string</AgencyType>
    <AppleAppStoreUrl>sample string</AppleAppStoreUrl>
    <ContactEmail>sample string</ContactEmail>
    <ContactPhone>sample string</ContactPhone>
    <ContactPhoneDigits>sample string</ContactPhoneDigits>
    <ContactPhoneDisplay>sample string</ContactPhoneDisplay>
    <ContactURL>sample string</ContactURL>
    <Description>sample string</Description>
    <Facebook>sample string</Facebook>
    <FaxNumber>sample string</FaxNumber>
    <FriendlyName>sample string</FriendlyName>
    <GaUA_ID>sample string</GaUA_ID>
    <GooglePlayStoreUrl>sample string</GooglePlayStoreUrl>
    <GssSearchEngineID>sample string</GssSearchEngineID>
    <HearingImpairedPhone>sample string</HearingImpairedPhone>
    <InstagramUrl>sample string</InstagramUrl>
    <Keywords>sample string</Keywords>
    <LinkedInUrl>sample string</LinkedInUrl>
    <LivechatLink>sample string</LivechatLink>
    <LogoUrl>sample string</LogoUrl>
    <LogoUrlWebp>sample string</LogoUrlWebp>
    <NewsFeed>sample string</NewsFeed>
    <PhoneHours>sample string</PhoneHours>
    <ServiceCategory>sample string</ServiceCategory>
    <ServiceNameTag>sample string</ServiceNameTag>
    <TwitterAccount>sample string</TwitterAccount>
    <Updated>2026-01-01T00:00:00Z</Updated>
    <WebsiteURL>sample string</WebsiteURL>
    <YouTube>sample string</YouTube>
  </ApiProfileViewModel>
</ArrayOfApiProfileViewModel>