GET api/CrmProfile/{id}?profileUid={profileUid}

Request Information

URI Parameters

Name	Description	Type	Additional information
profileUid		globally unique identifier	Required
id		string	None.

Body Parameters

None.

Response Information

Resource Description

CrmProfileResponse

Name	Type	Additional information
ResponseCode	integer	None.
ErrorString	string	None.
Profiles	Collection of CrmProfileViewModel	None.
Profile	CrmProfileViewModel	None.
Definitions	Collection of CrmSettingDefinitionViewModel	None.
TestResult	CrmProfileTestResultViewModel	None.

Response Formats

application/json, text/json

Sample:

{
  "responseCode": 1,
  "errorString": "sample string 2",
  "profiles": [
    {
      "uniqueId": "259c72cb-31e1-434d-9e4b-77d103a82588",
      "crmType": "sample string 2",
      "name": "sample string 3",
      "environment": "sample string 4",
      "isActive": true,
      "updatedDate": "2026-09-18T09:29:58.7911891+00:00",
      "settings": [
        {
          "settingKey": "sample string 1",
          "isSecret": true,
          "isConfigured": true,
          "valuePlain": "sample string 4",
          "keyVersion": "sample string 5",
          "updatedDate": "2026-09-18T09:29:58.7911891+00:00"
        },
        {
          "settingKey": "sample string 1",
          "isSecret": true,
          "isConfigured": true,
          "valuePlain": "sample string 4",
          "keyVersion": "sample string 5",
          "updatedDate": "2026-09-18T09:29:58.7911891+00:00"
        }
      ]
    },
    {
      "uniqueId": "259c72cb-31e1-434d-9e4b-77d103a82588",
      "crmType": "sample string 2",
      "name": "sample string 3",
      "environment": "sample string 4",
      "isActive": true,
      "updatedDate": "2026-09-18T09:29:58.7911891+00:00",
      "settings": [
        {
          "settingKey": "sample string 1",
          "isSecret": true,
          "isConfigured": true,
          "valuePlain": "sample string 4",
          "keyVersion": "sample string 5",
          "updatedDate": "2026-09-18T09:29:58.7911891+00:00"
        },
        {
          "settingKey": "sample string 1",
          "isSecret": true,
          "isConfigured": true,
          "valuePlain": "sample string 4",
          "keyVersion": "sample string 5",
          "updatedDate": "2026-09-18T09:29:58.7911891+00:00"
        }
      ]
    }
  ],
  "profile": {
    "uniqueId": "259c72cb-31e1-434d-9e4b-77d103a82588",
    "crmType": "sample string 2",
    "name": "sample string 3",
    "environment": "sample string 4",
    "isActive": true,
    "updatedDate": "2026-09-18T09:29:58.7911891+00:00",
    "settings": [
      {
        "settingKey": "sample string 1",
        "isSecret": true,
        "isConfigured": true,
        "valuePlain": "sample string 4",
        "keyVersion": "sample string 5",
        "updatedDate": "2026-09-18T09:29:58.7911891+00:00"
      },
      {
        "settingKey": "sample string 1",
        "isSecret": true,
        "isConfigured": true,
        "valuePlain": "sample string 4",
        "keyVersion": "sample string 5",
        "updatedDate": "2026-09-18T09:29:58.7911891+00:00"
      }
    ]
  },
  "definitions": [
    {
      "settingKey": "sample string 1",
      "label": "sample string 2",
      "isSecret": true,
      "isRequired": true
    },
    {
      "settingKey": "sample string 1",
      "label": "sample string 2",
      "isSecret": true,
      "isRequired": true
    }
  ],
  "testResult": {
    "success": true,
    "message": "sample string 2"
  }
}

application/xml, text/xml

Sample:

<CrmProfileResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels.Crm">
  <Definitions>
    <CrmSettingDefinitionViewModel>
      <IsRequired>true</IsRequired>
      <IsSecret>true</IsSecret>
      <Label>sample string 2</Label>
      <SettingKey>sample string 1</SettingKey>
    </CrmSettingDefinitionViewModel>
    <CrmSettingDefinitionViewModel>
      <IsRequired>true</IsRequired>
      <IsSecret>true</IsSecret>
      <Label>sample string 2</Label>
      <SettingKey>sample string 1</SettingKey>
    </CrmSettingDefinitionViewModel>
  </Definitions>
  <ErrorString>sample string 2</ErrorString>
  <Profile>
    <CrmType>sample string 2</CrmType>
    <Environment>sample string 4</Environment>
    <IsActive>true</IsActive>
    <Name>sample string 3</Name>
    <Settings>
      <CrmProfileSettingViewModel>
        <IsConfigured>true</IsConfigured>
        <IsSecret>true</IsSecret>
        <KeyVersion>sample string 5</KeyVersion>
        <SettingKey>sample string 1</SettingKey>
        <UpdatedDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>2026-09-18T09:29:58.7911891Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
        </UpdatedDate>
        <ValuePlain>sample string 4</ValuePlain>
      </CrmProfileSettingViewModel>
      <CrmProfileSettingViewModel>
        <IsConfigured>true</IsConfigured>
        <IsSecret>true</IsSecret>
        <KeyVersion>sample string 5</KeyVersion>
        <SettingKey>sample string 1</SettingKey>
        <UpdatedDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>2026-09-18T09:29:58.7911891Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
        </UpdatedDate>
        <ValuePlain>sample string 4</ValuePlain>
      </CrmProfileSettingViewModel>
    </Settings>
    <UniqueId>259c72cb-31e1-434d-9e4b-77d103a82588</UniqueId>
    <UpdatedDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2026-09-18T09:29:58.7911891Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </UpdatedDate>
  </Profile>
  <Profiles>
    <CrmProfileViewModel>
      <CrmType>sample string 2</CrmType>
      <Environment>sample string 4</Environment>
      <IsActive>true</IsActive>
      <Name>sample string 3</Name>
      <Settings>
        <CrmProfileSettingViewModel>
          <IsConfigured>true</IsConfigured>
          <IsSecret>true</IsSecret>
          <KeyVersion>sample string 5</KeyVersion>
          <SettingKey>sample string 1</SettingKey>
          <UpdatedDate xmlns:d6p1="http://schemas.datacontract.org/2004/07/System">
            <d6p1:DateTime>2026-09-18T09:29:58.7911891Z</d6p1:DateTime>
            <d6p1:OffsetMinutes>0</d6p1:OffsetMinutes>
          </UpdatedDate>
          <ValuePlain>sample string 4</ValuePlain>
        </CrmProfileSettingViewModel>
        <CrmProfileSettingViewModel>
          <IsConfigured>true</IsConfigured>
          <IsSecret>true</IsSecret>
          <KeyVersion>sample string 5</KeyVersion>
          <SettingKey>sample string 1</SettingKey>
          <UpdatedDate xmlns:d6p1="http://schemas.datacontract.org/2004/07/System">
            <d6p1:DateTime>2026-09-18T09:29:58.7911891Z</d6p1:DateTime>
            <d6p1:OffsetMinutes>0</d6p1:OffsetMinutes>
          </UpdatedDate>
          <ValuePlain>sample string 4</ValuePlain>
        </CrmProfileSettingViewModel>
      </Settings>
      <UniqueId>259c72cb-31e1-434d-9e4b-77d103a82588</UniqueId>
      <UpdatedDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2026-09-18T09:29:58.7911891Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </UpdatedDate>
    </CrmProfileViewModel>
    <CrmProfileViewModel>
      <CrmType>sample string 2</CrmType>
      <Environment>sample string 4</Environment>
      <IsActive>true</IsActive>
      <Name>sample string 3</Name>
      <Settings>
        <CrmProfileSettingViewModel>
          <IsConfigured>true</IsConfigured>
          <IsSecret>true</IsSecret>
          <KeyVersion>sample string 5</KeyVersion>
          <SettingKey>sample string 1</SettingKey>
          <UpdatedDate xmlns:d6p1="http://schemas.datacontract.org/2004/07/System">
            <d6p1:DateTime>2026-09-18T09:29:58.7911891Z</d6p1:DateTime>
            <d6p1:OffsetMinutes>0</d6p1:OffsetMinutes>
          </UpdatedDate>
          <ValuePlain>sample string 4</ValuePlain>
        </CrmProfileSettingViewModel>
        <CrmProfileSettingViewModel>
          <IsConfigured>true</IsConfigured>
          <IsSecret>true</IsSecret>
          <KeyVersion>sample string 5</KeyVersion>
          <SettingKey>sample string 1</SettingKey>
          <UpdatedDate xmlns:d6p1="http://schemas.datacontract.org/2004/07/System">
            <d6p1:DateTime>2026-09-18T09:29:58.7911891Z</d6p1:DateTime>
            <d6p1:OffsetMinutes>0</d6p1:OffsetMinutes>
          </UpdatedDate>
          <ValuePlain>sample string 4</ValuePlain>
        </CrmProfileSettingViewModel>
      </Settings>
      <UniqueId>259c72cb-31e1-434d-9e4b-77d103a82588</UniqueId>
      <UpdatedDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>2026-09-18T09:29:58.7911891Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </UpdatedDate>
    </CrmProfileViewModel>
  </Profiles>
  <ResponseCode>1</ResponseCode>
  <TestResult>
    <Message>sample string 2</Message>
    <Success>true</Success>
  </TestResult>
</CrmProfileResponse>