POST api/Agencies/Query

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
lang	string	None.
name	string	None.
agencyTypeIds	Collection of integer	None.
agencyTagIds	Collection of integer	None.
page	integer	None.
pageSize	integer	None.
sortDirection	SortDirection	None.

Request Formats

application/json, text/json

Sample:

{
  "lang": "sample string",
  "name": "sample string",
  "agencyTypeIds": [
    1,
    1
  ],
  "agencyTagIds": [
    1,
    1
  ],
  "page": 1,
  "pageSize": 1,
  "sortDirection": 0
}

application/xml, text/xml

Sample:

<QueryModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CA.GOV.AgencyProfileApi.Models">
  <agencyTagIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>1</d2p1:int>
  </agencyTagIds>
  <agencyTypeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>1</d2p1:int>
  </agencyTypeIds>
  <lang>sample string</lang>
  <name>sample string</name>
  <page>1</page>
  <pageSize>1</pageSize>
  <sortDirection>Ascending</sortDirection>
</QueryModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AgencyQueryResultModel

Name	Type	Additional information
Results	Collection of ApiProfileViewModel	None.
Page	integer	None.
PageSize	integer	None.
SortDirection	SortDirection	None.
TotalCount	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "Results": [
    {
      "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"
    }
  ],
  "Page": 1,
  "PageSize": 1,
  "SortDirection": 0,
  "TotalCount": 1
}

application/xml, text/xml

Sample:

<AgencyQueryResultModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CA.GOV.AgencyProfileApi.Models">
  <Page>1</Page>
  <PageSize>1</PageSize>
  <Results>
    <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>
  </Results>
  <SortDirection>Ascending</SortDirection>
  <TotalCount>1</TotalCount>
</AgencyQueryResultModel>