GET api/Agencies/GetAgencyById/{id}/{lang}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | integer |
Required |
|
| lang | string |
Default value is en |
Body Parameters
None.
Response Information
Resource Description
ApiProfileViewModel| Name | Description | Type | Additional information |
|---|---|---|---|
| AgencyId | integer |
None. |
|
| AgencyName | string |
None. |
|
| FriendlyName | string |
None. |
|
| AgencyType | string |
None. |
|
| ServiceCategory | string |
None. |
|
| Description | string |
None. |
|
| Acronym | string |
None. |
|
| LogoUrl | string |
None. |
|
| LogoUrlWebp | string |
None. |
|
| WebsiteURL | string |
None. |
|
| ContactPhone | string |
None. |
|
| ContactPhoneDisplay | string |
None. |
|
| ContactPhoneDigits | string |
None. |
|
| HearingImpairedPhone | string |
None. |
|
| FaxNumber | string |
None. |
|
| PhoneHours | string |
None. |
|
| ContactURL | string |
None. |
|
| ContactEmail | string |
None. |
|
| LivechatLink | string |
None. |
|
| TwitterAccount | string |
None. |
|
| string |
None. |
||
| YouTube | string |
None. |
|
| AppleAppStoreUrl | string |
None. |
|
| GooglePlayStoreUrl | string |
None. |
|
| NewsFeed | string |
None. |
|
| Updated | date |
None. |
|
| GssSearchEngineID | string |
None. |
|
| GaUA_ID | string |
None. |
|
| ServiceNameTag | string |
None. |
|
| AgencyTags | string |
None. |
|
| Keywords | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"AgencyId": 1,
"AgencyName": "sample string 2",
"FriendlyName": "sample string 3",
"AgencyType": "sample string 4",
"ServiceCategory": "sample string 5",
"Description": "sample string 6",
"Acronym": "sample string 7",
"LogoUrl": "sample string 8",
"LogoUrlWebp": "sample string 9",
"WebsiteURL": "sample string 10",
"ContactPhone": "sample string 11",
"ContactPhoneDisplay": "sample string 12",
"ContactPhoneDigits": "sample string 13",
"HearingImpairedPhone": "sample string 14",
"FaxNumber": "sample string 15",
"PhoneHours": "sample string 16",
"ContactURL": "sample string 17",
"ContactEmail": "sample string 18",
"LivechatLink": "sample string 19",
"TwitterAccount": "sample string 20",
"Facebook": "sample string 21",
"YouTube": "sample string 22",
"AppleAppStoreUrl": "sample string 23",
"GooglePlayStoreUrl": "sample string 24",
"NewsFeed": "sample string 25",
"Updated": "2026-03-17T02:18:40.7864776+00:00",
"GssSearchEngineID": "sample string 26",
"GaUA_ID": "sample string 27",
"ServiceNameTag": "sample string 28",
"AgencyTags": "sample string 29",
"Keywords": "sample string 30"
}
application/xml, text/xml
Sample:
<ApiProfileViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CA.GOV.AgencyProfileApi.Models"> <Acronym>sample string 7</Acronym> <AgencyId>1</AgencyId> <AgencyName>sample string 2</AgencyName> <AgencyTags>sample string 29</AgencyTags> <AgencyType>sample string 4</AgencyType> <AppleAppStoreUrl>sample string 23</AppleAppStoreUrl> <ContactEmail>sample string 18</ContactEmail> <ContactPhone>sample string 11</ContactPhone> <ContactPhoneDigits>sample string 13</ContactPhoneDigits> <ContactPhoneDisplay>sample string 12</ContactPhoneDisplay> <ContactURL>sample string 17</ContactURL> <Description>sample string 6</Description> <Facebook>sample string 21</Facebook> <FaxNumber>sample string 15</FaxNumber> <FriendlyName>sample string 3</FriendlyName> <GaUA_ID>sample string 27</GaUA_ID> <GooglePlayStoreUrl>sample string 24</GooglePlayStoreUrl> <GssSearchEngineID>sample string 26</GssSearchEngineID> <HearingImpairedPhone>sample string 14</HearingImpairedPhone> <Keywords>sample string 30</Keywords> <LivechatLink>sample string 19</LivechatLink> <LogoUrl>sample string 8</LogoUrl> <LogoUrlWebp>sample string 9</LogoUrlWebp> <NewsFeed>sample string 25</NewsFeed> <PhoneHours>sample string 16</PhoneHours> <ServiceCategory>sample string 5</ServiceCategory> <ServiceNameTag>sample string 28</ServiceNameTag> <TwitterAccount>sample string 20</TwitterAccount> <Updated>2026-03-17T02:18:40.7864776+00:00</Updated> <WebsiteURL>sample string 10</WebsiteURL> <YouTube>sample string 22</YouTube> </ApiProfileViewModel>