GET v1/admin/company/{id}
Gets the company details of the passed in company Id, secured by a security Fn
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
CompaniesOutput| Name | Description | Type | Additional information |
|---|---|---|---|
| id | integer |
None. |
|
| companyName | string |
None. |
|
| memberType | string |
None. |
|
| memberStatus | integer |
None. |
|
| memberStatusName | string |
None. |
|
| startDate | date |
None. |
|
| endDate | date |
None. |
|
| primaryFunctionId | integer |
None. |
|
| primaryFunction | string |
None. |
|
| phone | string |
None. |
|
| MainCountryCode | string |
None. |
|
| MainAreaCode | string |
None. |
|
| MainFaxCountryCode | string |
None. |
|
| MainFaxAreaCode | string |
None. |
|
| FaxPhone | string |
None. |
|
| website | string |
None. |
|
| MainEmail | string |
None. |
|
| JobsEmail | string |
None. |
|
| InfoEmail | string |
None. |
|
| billingAddress | string |
None. |
|
| BillingAddressLine1 | string |
None. |
|
| BillingAddressLine2 | string |
None. |
|
| BillingAddressLine3 | string |
None. |
|
| BillingAddressLine4 | string |
None. |
|
| BillingCity | string |
None. |
|
| BillingState | string |
None. |
|
| BillingCounty | string |
None. |
|
| BillingCountry | string |
None. |
|
| BillingCountryCodeID | string |
None. |
|
| Description | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"id": 1,
"companyName": "sample string 2",
"memberType": "sample string 3",
"memberStatus": 4,
"memberStatusName": "sample string 5",
"startDate": "2025-12-04T16:07:38.1235517+00:00",
"endDate": "2025-12-04T16:07:38.1235517+00:00",
"primaryFunctionId": 8,
"primaryFunction": "sample string 9",
"phone": "sample string 10",
"MainCountryCode": "sample string 11",
"MainAreaCode": "sample string 12",
"MainFaxCountryCode": "sample string 13",
"MainFaxAreaCode": "sample string 14",
"FaxPhone": "sample string 15",
"website": "sample string 16",
"MainEmail": "sample string 17",
"JobsEmail": "sample string 18",
"InfoEmail": "sample string 19",
"billingAddress": "sample string 20",
"BillingAddressLine1": "sample string 21",
"BillingAddressLine2": "sample string 22",
"BillingAddressLine3": "sample string 23",
"BillingAddressLine4": "sample string 24",
"BillingCity": "sample string 25",
"BillingState": "sample string 26",
"BillingCounty": "sample string 27",
"BillingCountry": "sample string 28",
"BillingCountryCodeID": "sample string 29",
"Description": "sample string 30"
}
text/html
Sample:
{"id":1,"companyName":"sample string 2","memberType":"sample string 3","memberStatus":4,"memberStatusName":"sample string 5","startDate":"2025-12-04T16:07:38.1235517+00:00","endDate":"2025-12-04T16:07:38.1235517+00:00","primaryFunctionId":8,"primaryFunction":"sample string 9","phone":"sample string 10","MainCountryCode":"sample string 11","MainAreaCode":"sample string 12","MainFaxCountryCode":"sample string 13","MainFaxAreaCode":"sample string 14","FaxPhone":"sample string 15","website":"sample string 16","MainEmail":"sample string 17","JobsEmail":"sample string 18","InfoEmail":"sample string 19","billingAddress":"sample string 20","BillingAddressLine1":"sample string 21","BillingAddressLine2":"sample string 22","BillingAddressLine3":"sample string 23","BillingAddressLine4":"sample string 24","BillingCity":"sample string 25","BillingState":"sample string 26","BillingCounty":"sample string 27","BillingCountry":"sample string 28","BillingCountryCodeID":"sample string 29","Description":"sample string 30"}
application/xml, text/xml
Sample:
<v1_Admin_CompanyEndpointController.CompaniesOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aptify.Services.Generated.v1_Admin_CompanyEndpoint"> <BillingAddressLine1>sample string 21</BillingAddressLine1> <BillingAddressLine2>sample string 22</BillingAddressLine2> <BillingAddressLine3>sample string 23</BillingAddressLine3> <BillingAddressLine4>sample string 24</BillingAddressLine4> <BillingCity>sample string 25</BillingCity> <BillingCountry>sample string 28</BillingCountry> <BillingCountryCodeID>sample string 29</BillingCountryCodeID> <BillingCounty>sample string 27</BillingCounty> <BillingState>sample string 26</BillingState> <Description>sample string 30</Description> <FaxPhone>sample string 15</FaxPhone> <InfoEmail>sample string 19</InfoEmail> <JobsEmail>sample string 18</JobsEmail> <MainAreaCode>sample string 12</MainAreaCode> <MainCountryCode>sample string 11</MainCountryCode> <MainEmail>sample string 17</MainEmail> <MainFaxAreaCode>sample string 14</MainFaxAreaCode> <MainFaxCountryCode>sample string 13</MainFaxCountryCode> <billingAddress>sample string 20</billingAddress> <companyName>sample string 2</companyName> <endDate>2025-12-04T16:07:38.1235517+00:00</endDate> <id>1</id> <memberStatus>4</memberStatus> <memberStatusName>sample string 5</memberStatusName> <memberType>sample string 3</memberType> <phone>sample string 10</phone> <primaryFunction>sample string 9</primaryFunction> <primaryFunctionId>8</primaryFunctionId> <startDate>2025-12-04T16:07:38.1235517+00:00</startDate> <website>sample string 16</website> </v1_Admin_CompanyEndpointController.CompaniesOutput>