GET api/Parties/{id}

Fetch a specific party

Request Information

URI Parameters

Name	Description	Type	Additional information
id		integer	Required

Body Parameters

None.

Response Information

Resource Description

Party

Name	Type	Additional information
OrgNr	string	None.
Nr	string	None.
Street	string	None.
Zip	string	None.
City	string	None.
Phone	string	None.
Fax	string	None.
Email	string	None.
Contact	string	None.
CountryCode	string	None.
ClassificationId	integer	None.
PartyStatusId	integer	None.
Note	string	None.
Comments	Collection of Comment	None.
Documents	Collection of Document	None.
Notifications	Collection of Notification	None.
TagIds	Collection of integer	None.
CompanyId	integer	None.
Name	string	None.
LastModified	date	None.
Created	date	None.
Id	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "OrgNr": "sample string 1",
  "Nr": "sample string 2",
  "Street": "sample string 3",
  "Zip": "sample string 4",
  "City": "sample string 5",
  "Phone": "sample string 6",
  "Fax": "sample string 7",
  "Email": "sample string 8",
  "Contact": "sample string 9",
  "CountryCode": "sample string 10",
  "ClassificationId": 11,
  "PartyStatusId": 12,
  "Note": "sample string 13",
  "Comments": [
    {
      "UserId": 1,
      "Text": "sample string 2",
      "Date": "2025-12-08T14:21:25.2268272+00:00",
      "Id": 4
    },
    {
      "UserId": 1,
      "Text": "sample string 2",
      "Date": "2025-12-08T14:21:25.2268272+00:00",
      "Id": 4
    }
  ],
  "Documents": [
    {
      "ContentType": "sample string 1",
      "Content": "sample string 2",
      "ParseLanguage": "sample string 3",
      "CompanyId": 4,
      "Name": "sample string 5",
      "LastModified": "2025-12-08T14:21:25.2268272+00:00",
      "Created": "2025-12-08T14:21:25.2268272+00:00",
      "Id": 8
    },
    {
      "ContentType": "sample string 1",
      "Content": "sample string 2",
      "ParseLanguage": "sample string 3",
      "CompanyId": 4,
      "Name": "sample string 5",
      "LastModified": "2025-12-08T14:21:25.2268272+00:00",
      "Created": "2025-12-08T14:21:25.2268272+00:00",
      "Id": 8
    }
  ],
  "Notifications": [
    {
      "Name": "sample string 1",
      "ReminderCount": 2,
      "EscalationCount": 3,
      "Active": true,
      "CommentText": "sample string 5",
      "StartDate": "2025-12-08T14:21:25.2268272+00:00",
      "EndDate": "2025-12-08T14:21:25.2268272+00:00",
      "Confirmed": "2025-12-08T14:21:25.2268272+00:00",
      "Type": "sample string 9",
      "ConfirmedByUserId": 10,
      "Message": "sample string 11",
      "RecipientUserIds": [
        1,
        2
      ],
      "Id": 12
    },
    {
      "Name": "sample string 1",
      "ReminderCount": 2,
      "EscalationCount": 3,
      "Active": true,
      "CommentText": "sample string 5",
      "StartDate": "2025-12-08T14:21:25.2268272+00:00",
      "EndDate": "2025-12-08T14:21:25.2268272+00:00",
      "Confirmed": "2025-12-08T14:21:25.2268272+00:00",
      "Type": "sample string 9",
      "ConfirmedByUserId": 10,
      "Message": "sample string 11",
      "RecipientUserIds": [
        1,
        2
      ],
      "Id": 12
    }
  ],
  "TagIds": [
    1,
    2
  ],
  "CompanyId": 14,
  "Name": "sample string 15",
  "LastModified": "2025-12-08T14:21:25.2268272+00:00",
  "Created": "2025-12-08T14:21:25.2268272+00:00",
  "Id": 18
}

application/xml, text/xml

Sample:

<Party xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ControlKeeper.ApiModel">
  <Id>18</Id>
  <Created>2025-12-08T14:21:25.2268272+00:00</Created>
  <LastModified>2025-12-08T14:21:25.2268272+00:00</LastModified>
  <Name>sample string 15</Name>
  <CompanyId>14</CompanyId>
  <City>sample string 5</City>
  <ClassificationId>11</ClassificationId>
  <Comments>
    <Comment>
      <Id>4</Id>
      <Date>2025-12-08T14:21:25.2268272+00:00</Date>
      <Text>sample string 2</Text>
      <UserId>1</UserId>
    </Comment>
    <Comment>
      <Id>4</Id>
      <Date>2025-12-08T14:21:25.2268272+00:00</Date>
      <Text>sample string 2</Text>
      <UserId>1</UserId>
    </Comment>
  </Comments>
  <Contact>sample string 9</Contact>
  <CountryCode>sample string 10</CountryCode>
  <Documents>
    <Document>
      <Id>8</Id>
      <Created>2025-12-08T14:21:25.2268272+00:00</Created>
      <LastModified>2025-12-08T14:21:25.2268272+00:00</LastModified>
      <Name>sample string 5</Name>
      <CompanyId>4</CompanyId>
      <Content>sample string 2</Content>
      <ContentType>sample string 1</ContentType>
      <ParseLanguage>sample string 3</ParseLanguage>
    </Document>
    <Document>
      <Id>8</Id>
      <Created>2025-12-08T14:21:25.2268272+00:00</Created>
      <LastModified>2025-12-08T14:21:25.2268272+00:00</LastModified>
      <Name>sample string 5</Name>
      <CompanyId>4</CompanyId>
      <Content>sample string 2</Content>
      <ContentType>sample string 1</ContentType>
      <ParseLanguage>sample string 3</ParseLanguage>
    </Document>
  </Documents>
  <Email>sample string 8</Email>
  <Fax>sample string 7</Fax>
  <Note>sample string 13</Note>
  <Notifications>
    <Notification>
      <Id>12</Id>
      <Active>true</Active>
      <CommentText>sample string 5</CommentText>
      <Confirmed>2025-12-08T14:21:25.2268272+00:00</Confirmed>
      <ConfirmedByUserId>10</ConfirmedByUserId>
      <EndDate>2025-12-08T14:21:25.2268272+00:00</EndDate>
      <EscalationCount>3</EscalationCount>
      <Message>sample string 11</Message>
      <Name>sample string 1</Name>
      <RecipientUserIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </RecipientUserIds>
      <ReminderCount>2</ReminderCount>
      <StartDate>2025-12-08T14:21:25.2268272+00:00</StartDate>
      <Type>sample string 9</Type>
    </Notification>
    <Notification>
      <Id>12</Id>
      <Active>true</Active>
      <CommentText>sample string 5</CommentText>
      <Confirmed>2025-12-08T14:21:25.2268272+00:00</Confirmed>
      <ConfirmedByUserId>10</ConfirmedByUserId>
      <EndDate>2025-12-08T14:21:25.2268272+00:00</EndDate>
      <EscalationCount>3</EscalationCount>
      <Message>sample string 11</Message>
      <Name>sample string 1</Name>
      <RecipientUserIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>1</d4p1:int>
        <d4p1:int>2</d4p1:int>
      </RecipientUserIds>
      <ReminderCount>2</ReminderCount>
      <StartDate>2025-12-08T14:21:25.2268272+00:00</StartDate>
      <Type>sample string 9</Type>
    </Notification>
  </Notifications>
  <Nr>sample string 2</Nr>
  <OrgNr>sample string 1</OrgNr>
  <PartyStatusId>12</PartyStatusId>
  <Phone>sample string 6</Phone>
  <Street>sample string 3</Street>
  <TagIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </TagIds>
  <Zip>sample string 4</Zip>
</Party>