GET api/Contacts/{id}

Returns a specific contact

Request Information

URI Parameters

Name	Description	Type	Additional information
id	The ID of the contact	integer	Required

Body Parameters

None.

Response Information

Resource Description

Contact

Name	Type	Additional information
ContactId	integer	None.
UnitId	integer	None.
EmployeeID	string	None.
Title	string	None.
Salutation	string	None.
FirstName	string	None.
MiddleInitial	string	None.
LastName	string	None.
SpouseName	string	None.
BusinessName	string	None.
OrganizationName	string	None.
HomePhone	string	None.
WorkPhone	string	None.
WorkPhoneExtension	string	None.
Fax	string	None.
Mobile	string	None.
Username	string	None.
Password	string	None.
Email	string	None.
Email2	string	None.
IsActive	boolean	None.
Url	string	None.
Comments	string	None.
GenderCode	string	None.
DateOfBirth	date	None.
IsAdult	boolean	None.
School	string	None.
HasImage	boolean	None.
ImageUrl	string	None.
CreateDate	date	None.
ModifyDate	date	None.
Addresses	Collection of Address	None.
ContactAccounts	Collection of AccountContact	None.
UdfValues	Collection of ContactUdfValue	None.
Links	Collection of Link	None.

Response Formats

application/json, text/json

Sample:

{
  "ContactId": 1,
  "UnitId": 2,
  "EmployeeID": "sample string 3",
  "Title": "sample string 4",
  "Salutation": "sample string 5",
  "FirstName": "sample string 6",
  "MiddleInitial": "sample string 7",
  "LastName": "sample string 8",
  "SpouseName": "sample string 9",
  "BusinessName": "sample string 10",
  "OrganizationName": "sample string 11",
  "HomePhone": "sample string 12",
  "WorkPhone": "sample string 13",
  "WorkPhoneExtension": "sample string 14",
  "Fax": "sample string 15",
  "Mobile": "sample string 16",
  "Username": "sample string 17",
  "Password": "sample string 18",
  "Email": "sample string 19",
  "Email2": "sample string 20",
  "IsActive": true,
  "Url": "sample string 22",
  "Comments": "sample string 23",
  "GenderCode": "sample string 24",
  "DateOfBirth": "2026-04-04T00:33:18.488444-07:00",
  "IsAdult": true,
  "School": "sample string 26",
  "HasImage": true,
  "ImageUrl": "sample string 28",
  "CreateDate": "2026-04-04T00:33:18.488444-07:00",
  "ModifyDate": "2026-04-04T00:33:18.488444-07:00",
  "Addresses": [
    {
      "AddressId": 1,
      "AddressType": {
        "AddressTypeId": 1,
        "OrganizationId": 2,
        "Description": "sample string 3",
        "IsActive": true,
        "IsSystemDefined": true,
        "CreateDate": "2026-04-04T00:33:18.488444-07:00",
        "CreateUserId": 6,
        "ModifyDate": "2026-04-04T00:33:18.488444-07:00",
        "ModifyUserId": 7,
        "Links": [
          {
            "Rel": "sample string 1",
            "Href": "sample string 2",
            "Title": "sample string 3",
            "Type": "sample string 4"
          },
          {
            "Rel": "sample string 1",
            "Href": "sample string 2",
            "Title": "sample string 3",
            "Type": "sample string 4"
          }
        ]
      },
      "UnitId": 2,
      "ContactId": 3,
      "IsPrimary": true,
      "StreetAddress1": "sample string 5",
      "StreetAddress2": "sample string 6",
      "City": "sample string 7",
      "State": {
        "StateId": 1,
        "OrganizationId": 2,
        "Name": "sample string 3",
        "Abbreviation": "sample string 4",
        "IsActive": true,
        "Links": [
          {
            "Rel": "sample string 1",
            "Href": "sample string 2",
            "Title": "sample string 3",
            "Type": "sample string 4"
          },
          {
            "Rel": "sample string 1",
            "Href": "sample string 2",
            "Title": "sample string 3",
            "Type": "sample string 4"
          }
        ]
      },
      "PostalCode": "sample string 8",
      "Links": [
        {
          "Rel": "sample string 1",
          "Href": "sample string 2",
          "Title": "sample string 3",
          "Type": "sample string 4"
        },
        {
          "Rel": "sample string 1",
          "Href": "sample string 2",
          "Title": "sample string 3",
          "Type": "sample string 4"
        }
      ]
    },
    {
      "AddressId": 1,
      "AddressType": {
        "AddressTypeId": 1,
        "OrganizationId": 2,
        "Description": "sample string 3",
        "IsActive": true,
        "IsSystemDefined": true,
        "CreateDate": "2026-04-04T00:33:18.488444-07:00",
        "CreateUserId": 6,
        "ModifyDate": "2026-04-04T00:33:18.488444-07:00",
        "ModifyUserId": 7,
        "Links": [
          {
            "Rel": "sample string 1",
            "Href": "sample string 2",
            "Title": "sample string 3",
            "Type": "sample string 4"
          },
          {
            "Rel": "sample string 1",
            "Href": "sample string 2",
            "Title": "sample string 3",
            "Type": "sample string 4"
          }
        ]
      },
      "UnitId": 2,
      "ContactId": 3,
      "IsPrimary": true,
      "StreetAddress1": "sample string 5",
      "StreetAddress2": "sample string 6",
      "City": "sample string 7",
      "State": {
        "StateId": 1,
        "OrganizationId": 2,
        "Name": "sample string 3",
        "Abbreviation": "sample string 4",
        "IsActive": true,
        "Links": [
          {
            "Rel": "sample string 1",
            "Href": "sample string 2",
            "Title": "sample string 3",
            "Type": "sample string 4"
          },
          {
            "Rel": "sample string 1",
            "Href": "sample string 2",
            "Title": "sample string 3",
            "Type": "sample string 4"
          }
        ]
      },
      "PostalCode": "sample string 8",
      "Links": [
        {
          "Rel": "sample string 1",
          "Href": "sample string 2",
          "Title": "sample string 3",
          "Type": "sample string 4"
        },
        {
          "Rel": "sample string 1",
          "Href": "sample string 2",
          "Title": "sample string 3",
          "Type": "sample string 4"
        }
      ]
    }
  ],
  "ContactAccounts": [
    {
      "AccountContactId": 1,
      "AccountId": 2,
      "ContactId": 3,
      "AccountContactType": {
        "AccountContactTypeId": 1,
        "OrganizationId": 2,
        "Description": "sample string 3",
        "IsActive": true,
        "IsSystemDefined": true,
        "IsAvailableOnline": true,
        "IsAvailableForAdult": true,
        "IsAvailableForChild": true,
        "Links": [
          {
            "Rel": "sample string 1",
            "Href": "sample string 2",
            "Title": "sample string 3",
            "Type": "sample string 4"
          },
          {
            "Rel": "sample string 1",
            "Href": "sample string 2",
            "Title": "sample string 3",
            "Type": "sample string 4"
          }
        ]
      },
      "IsPrimary": true,
      "IsBilling": true,
      "IsEmergency": true,
      "IsActive": true,
      "CanRegisterSelfOnline": true,
      "CanRegisterSelfAndOthersOnline": true,
      "CanEditDataOnline": true,
      "UnitId": 11,
      "Links": [
        {
          "Rel": "sample string 1",
          "Href": "sample string 2",
          "Title": "sample string 3",
          "Type": "sample string 4"
        },
        {
          "Rel": "sample string 1",
          "Href": "sample string 2",
          "Title": "sample string 3",
          "Type": "sample string 4"
        }
      ]
    },
    {
      "AccountContactId": 1,
      "AccountId": 2,
      "ContactId": 3,
      "AccountContactType": {
        "AccountContactTypeId": 1,
        "OrganizationId": 2,
        "Description": "sample string 3",
        "IsActive": true,
        "IsSystemDefined": true,
        "IsAvailableOnline": true,
        "IsAvailableForAdult": true,
        "IsAvailableForChild": true,
        "Links": [
          {
            "Rel": "sample string 1",
            "Href": "sample string 2",
            "Title": "sample string 3",
            "Type": "sample string 4"
          },
          {
            "Rel": "sample string 1",
            "Href": "sample string 2",
            "Title": "sample string 3",
            "Type": "sample string 4"
          }
        ]
      },
      "IsPrimary": true,
      "IsBilling": true,
      "IsEmergency": true,
      "IsActive": true,
      "CanRegisterSelfOnline": true,
      "CanRegisterSelfAndOthersOnline": true,
      "CanEditDataOnline": true,
      "UnitId": 11,
      "Links": [
        {
          "Rel": "sample string 1",
          "Href": "sample string 2",
          "Title": "sample string 3",
          "Type": "sample string 4"
        },
        {
          "Rel": "sample string 1",
          "Href": "sample string 2",
          "Title": "sample string 3",
          "Type": "sample string 4"
        }
      ]
    }
  ],
  "UdfValues": [
    {
      "ContactUdfValueId": 1,
      "UnitId": 2,
      "ContactId": 3,
      "UdfFieldId": 4,
      "DataType": {
        "UdfDataTypeId": 1,
        "OrganizationId": 2,
        "Description": "sample string 3",
        "IsActive": true,
        "IsSystemDefined": true,
        "Links": [
          {
            "Rel": "sample string 1",
            "Href": "sample string 2",
            "Title": "sample string 3",
            "Type": "sample string 4"
          },
          {
            "Rel": "sample string 1",
            "Href": "sample string 2",
            "Title": "sample string 3",
            "Type": "sample string 4"
          }
        ]
      },
      "Value": {},
      "Links": [
        {
          "Rel": "sample string 1",
          "Href": "sample string 2",
          "Title": "sample string 3",
          "Type": "sample string 4"
        },
        {
          "Rel": "sample string 1",
          "Href": "sample string 2",
          "Title": "sample string 3",
          "Type": "sample string 4"
        }
      ]
    },
    {
      "ContactUdfValueId": 1,
      "UnitId": 2,
      "ContactId": 3,
      "UdfFieldId": 4,
      "DataType": {
        "UdfDataTypeId": 1,
        "OrganizationId": 2,
        "Description": "sample string 3",
        "IsActive": true,
        "IsSystemDefined": true,
        "Links": [
          {
            "Rel": "sample string 1",
            "Href": "sample string 2",
            "Title": "sample string 3",
            "Type": "sample string 4"
          },
          {
            "Rel": "sample string 1",
            "Href": "sample string 2",
            "Title": "sample string 3",
            "Type": "sample string 4"
          }
        ]
      },
      "Value": {},
      "Links": [
        {
          "Rel": "sample string 1",
          "Href": "sample string 2",
          "Title": "sample string 3",
          "Type": "sample string 4"
        },
        {
          "Rel": "sample string 1",
          "Href": "sample string 2",
          "Title": "sample string 3",
          "Type": "sample string 4"
        }
      ]
    }
  ],
  "Links": [
    {
      "Rel": "sample string 1",
      "Href": "sample string 2",
      "Title": "sample string 3",
      "Type": "sample string 4"
    },
    {
      "Rel": "sample string 1",
      "Href": "sample string 2",
      "Title": "sample string 3",
      "Type": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample:

<Contact xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProClassApi.Web.Api.Models">
  <Addresses>
    <Address>
      <AddressId>1</AddressId>
      <AddressType>
        <AddressTypeId>1</AddressTypeId>
        <CreateDate>2026-04-04T00:33:18.488444-07:00</CreateDate>
        <CreateUserId>6</CreateUserId>
        <Description>sample string 3</Description>
        <IsActive>true</IsActive>
        <IsSystemDefined>true</IsSystemDefined>
        <Links>
          <Link>
            <Href>sample string 2</Href>
            <Rel>sample string 1</Rel>
            <Title>sample string 3</Title>
            <Type>sample string 4</Type>
          </Link>
          <Link>
            <Href>sample string 2</Href>
            <Rel>sample string 1</Rel>
            <Title>sample string 3</Title>
            <Type>sample string 4</Type>
          </Link>
        </Links>
        <ModifyDate>2026-04-04T00:33:18.488444-07:00</ModifyDate>
        <ModifyUserId>7</ModifyUserId>
        <OrganizationId>2</OrganizationId>
      </AddressType>
      <City>sample string 7</City>
      <ContactId>3</ContactId>
      <IsPrimary>true</IsPrimary>
      <Links>
        <Link>
          <Href>sample string 2</Href>
          <Rel>sample string 1</Rel>
          <Title>sample string 3</Title>
          <Type>sample string 4</Type>
        </Link>
        <Link>
          <Href>sample string 2</Href>
          <Rel>sample string 1</Rel>
          <Title>sample string 3</Title>
          <Type>sample string 4</Type>
        </Link>
      </Links>
      <PostalCode>sample string 8</PostalCode>
      <State>
        <Abbreviation>sample string 4</Abbreviation>
        <IsActive>true</IsActive>
        <Links>
          <Link>
            <Href>sample string 2</Href>
            <Rel>sample string 1</Rel>
            <Title>sample string 3</Title>
            <Type>sample string 4</Type>
          </Link>
          <Link>
            <Href>sample string 2</Href>
            <Rel>sample string 1</Rel>
            <Title>sample string 3</Title>
            <Type>sample string 4</Type>
          </Link>
        </Links>
        <Name>sample string 3</Name>
        <OrganizationId>2</OrganizationId>
        <StateId>1</StateId>
      </State>
      <StreetAddress1>sample string 5</StreetAddress1>
      <StreetAddress2>sample string 6</StreetAddress2>
      <UnitId>2</UnitId>
    </Address>
    <Address>
      <AddressId>1</AddressId>
      <AddressType>
        <AddressTypeId>1</AddressTypeId>
        <CreateDate>2026-04-04T00:33:18.488444-07:00</CreateDate>
        <CreateUserId>6</CreateUserId>
        <Description>sample string 3</Description>
        <IsActive>true</IsActive>
        <IsSystemDefined>true</IsSystemDefined>
        <Links>
          <Link>
            <Href>sample string 2</Href>
            <Rel>sample string 1</Rel>
            <Title>sample string 3</Title>
            <Type>sample string 4</Type>
          </Link>
          <Link>
            <Href>sample string 2</Href>
            <Rel>sample string 1</Rel>
            <Title>sample string 3</Title>
            <Type>sample string 4</Type>
          </Link>
        </Links>
        <ModifyDate>2026-04-04T00:33:18.488444-07:00</ModifyDate>
        <ModifyUserId>7</ModifyUserId>
        <OrganizationId>2</OrganizationId>
      </AddressType>
      <City>sample string 7</City>
      <ContactId>3</ContactId>
      <IsPrimary>true</IsPrimary>
      <Links>
        <Link>
          <Href>sample string 2</Href>
          <Rel>sample string 1</Rel>
          <Title>sample string 3</Title>
          <Type>sample string 4</Type>
        </Link>
        <Link>
          <Href>sample string 2</Href>
          <Rel>sample string 1</Rel>
          <Title>sample string 3</Title>
          <Type>sample string 4</Type>
        </Link>
      </Links>
      <PostalCode>sample string 8</PostalCode>
      <State>
        <Abbreviation>sample string 4</Abbreviation>
        <IsActive>true</IsActive>
        <Links>
          <Link>
            <Href>sample string 2</Href>
            <Rel>sample string 1</Rel>
            <Title>sample string 3</Title>
            <Type>sample string 4</Type>
          </Link>
          <Link>
            <Href>sample string 2</Href>
            <Rel>sample string 1</Rel>
            <Title>sample string 3</Title>
            <Type>sample string 4</Type>
          </Link>
        </Links>
        <Name>sample string 3</Name>
        <OrganizationId>2</OrganizationId>
        <StateId>1</StateId>
      </State>
      <StreetAddress1>sample string 5</StreetAddress1>
      <StreetAddress2>sample string 6</StreetAddress2>
      <UnitId>2</UnitId>
    </Address>
  </Addresses>
  <BusinessName>sample string 10</BusinessName>
  <Comments>sample string 23</Comments>
  <ContactAccounts>
    <AccountContact>
      <AccountContactId>1</AccountContactId>
      <AccountContactType>
        <AccountContactTypeId>1</AccountContactTypeId>
        <Description>sample string 3</Description>
        <IsActive>true</IsActive>
        <IsAvailableForAdult>true</IsAvailableForAdult>
        <IsAvailableForChild>true</IsAvailableForChild>
        <IsAvailableOnline>true</IsAvailableOnline>
        <IsSystemDefined>true</IsSystemDefined>
        <Links>
          <Link>
            <Href>sample string 2</Href>
            <Rel>sample string 1</Rel>
            <Title>sample string 3</Title>
            <Type>sample string 4</Type>
          </Link>
          <Link>
            <Href>sample string 2</Href>
            <Rel>sample string 1</Rel>
            <Title>sample string 3</Title>
            <Type>sample string 4</Type>
          </Link>
        </Links>
        <OrganizationId>2</OrganizationId>
      </AccountContactType>
      <AccountId>2</AccountId>
      <CanEditDataOnline>true</CanEditDataOnline>
      <CanRegisterSelfAndOthersOnline>true</CanRegisterSelfAndOthersOnline>
      <CanRegisterSelfOnline>true</CanRegisterSelfOnline>
      <ContactId>3</ContactId>
      <IsActive>true</IsActive>
      <IsBilling>true</IsBilling>
      <IsEmergency>true</IsEmergency>
      <IsPrimary>true</IsPrimary>
      <Links>
        <Link>
          <Href>sample string 2</Href>
          <Rel>sample string 1</Rel>
          <Title>sample string 3</Title>
          <Type>sample string 4</Type>
        </Link>
        <Link>
          <Href>sample string 2</Href>
          <Rel>sample string 1</Rel>
          <Title>sample string 3</Title>
          <Type>sample string 4</Type>
        </Link>
      </Links>
      <UnitId>11</UnitId>
    </AccountContact>
    <AccountContact>
      <AccountContactId>1</AccountContactId>
      <AccountContactType>
        <AccountContactTypeId>1</AccountContactTypeId>
        <Description>sample string 3</Description>
        <IsActive>true</IsActive>
        <IsAvailableForAdult>true</IsAvailableForAdult>
        <IsAvailableForChild>true</IsAvailableForChild>
        <IsAvailableOnline>true</IsAvailableOnline>
        <IsSystemDefined>true</IsSystemDefined>
        <Links>
          <Link>
            <Href>sample string 2</Href>
            <Rel>sample string 1</Rel>
            <Title>sample string 3</Title>
            <Type>sample string 4</Type>
          </Link>
          <Link>
            <Href>sample string 2</Href>
            <Rel>sample string 1</Rel>
            <Title>sample string 3</Title>
            <Type>sample string 4</Type>
          </Link>
        </Links>
        <OrganizationId>2</OrganizationId>
      </AccountContactType>
      <AccountId>2</AccountId>
      <CanEditDataOnline>true</CanEditDataOnline>
      <CanRegisterSelfAndOthersOnline>true</CanRegisterSelfAndOthersOnline>
      <CanRegisterSelfOnline>true</CanRegisterSelfOnline>
      <ContactId>3</ContactId>
      <IsActive>true</IsActive>
      <IsBilling>true</IsBilling>
      <IsEmergency>true</IsEmergency>
      <IsPrimary>true</IsPrimary>
      <Links>
        <Link>
          <Href>sample string 2</Href>
          <Rel>sample string 1</Rel>
          <Title>sample string 3</Title>
          <Type>sample string 4</Type>
        </Link>
        <Link>
          <Href>sample string 2</Href>
          <Rel>sample string 1</Rel>
          <Title>sample string 3</Title>
          <Type>sample string 4</Type>
        </Link>
      </Links>
      <UnitId>11</UnitId>
    </AccountContact>
  </ContactAccounts>
  <ContactId>1</ContactId>
  <CreateDate>2026-04-04T00:33:18.488444-07:00</CreateDate>
  <DateOfBirth>2026-04-04T00:33:18.488444-07:00</DateOfBirth>
  <Email>sample string 19</Email>
  <Email2>sample string 20</Email2>
  <EmployeeID>sample string 3</EmployeeID>
  <Fax>sample string 15</Fax>
  <FirstName>sample string 6</FirstName>
  <GenderCode>sample string 24</GenderCode>
  <HasImage>true</HasImage>
  <HomePhone>sample string 12</HomePhone>
  <ImageUrl>sample string 28</ImageUrl>
  <IsActive>true</IsActive>
  <IsAdult>true</IsAdult>
  <LastName>sample string 8</LastName>
  <Links>
    <Link>
      <Href>sample string 2</Href>
      <Rel>sample string 1</Rel>
      <Title>sample string 3</Title>
      <Type>sample string 4</Type>
    </Link>
    <Link>
      <Href>sample string 2</Href>
      <Rel>sample string 1</Rel>
      <Title>sample string 3</Title>
      <Type>sample string 4</Type>
    </Link>
  </Links>
  <MiddleInitial>sample string 7</MiddleInitial>
  <Mobile>sample string 16</Mobile>
  <ModifyDate>2026-04-04T00:33:18.488444-07:00</ModifyDate>
  <OrganizationName>sample string 11</OrganizationName>
  <Password>sample string 18</Password>
  <Salutation>sample string 5</Salutation>
  <School>sample string 26</School>
  <SpouseName>sample string 9</SpouseName>
  <Title>sample string 4</Title>
  <UdfValues>
    <ContactUdfValue>
      <ContactId>3</ContactId>
      <ContactUdfValueId>1</ContactUdfValueId>
      <DataType>
        <Description>sample string 3</Description>
        <IsActive>true</IsActive>
        <IsSystemDefined>true</IsSystemDefined>
        <Links>
          <Link>
            <Href>sample string 2</Href>
            <Rel>sample string 1</Rel>
            <Title>sample string 3</Title>
            <Type>sample string 4</Type>
          </Link>
          <Link>
            <Href>sample string 2</Href>
            <Rel>sample string 1</Rel>
            <Title>sample string 3</Title>
            <Type>sample string 4</Type>
          </Link>
        </Links>
        <OrganizationId>2</OrganizationId>
        <UdfDataTypeId>1</UdfDataTypeId>
      </DataType>
      <Links>
        <Link>
          <Href>sample string 2</Href>
          <Rel>sample string 1</Rel>
          <Title>sample string 3</Title>
          <Type>sample string 4</Type>
        </Link>
        <Link>
          <Href>sample string 2</Href>
          <Rel>sample string 1</Rel>
          <Title>sample string 3</Title>
          <Type>sample string 4</Type>
        </Link>
      </Links>
      <UdfFieldId>4</UdfFieldId>
      <UnitId>2</UnitId>
      <Value />
    </ContactUdfValue>
    <ContactUdfValue>
      <ContactId>3</ContactId>
      <ContactUdfValueId>1</ContactUdfValueId>
      <DataType>
        <Description>sample string 3</Description>
        <IsActive>true</IsActive>
        <IsSystemDefined>true</IsSystemDefined>
        <Links>
          <Link>
            <Href>sample string 2</Href>
            <Rel>sample string 1</Rel>
            <Title>sample string 3</Title>
            <Type>sample string 4</Type>
          </Link>
          <Link>
            <Href>sample string 2</Href>
            <Rel>sample string 1</Rel>
            <Title>sample string 3</Title>
            <Type>sample string 4</Type>
          </Link>
        </Links>
        <OrganizationId>2</OrganizationId>
        <UdfDataTypeId>1</UdfDataTypeId>
      </DataType>
      <Links>
        <Link>
          <Href>sample string 2</Href>
          <Rel>sample string 1</Rel>
          <Title>sample string 3</Title>
          <Type>sample string 4</Type>
        </Link>
        <Link>
          <Href>sample string 2</Href>
          <Rel>sample string 1</Rel>
          <Title>sample string 3</Title>
          <Type>sample string 4</Type>
        </Link>
      </Links>
      <UdfFieldId>4</UdfFieldId>
      <UnitId>2</UnitId>
      <Value />
    </ContactUdfValue>
  </UdfValues>
  <UnitId>2</UnitId>
  <Url>sample string 22</Url>
  <Username>sample string 17</Username>
  <WorkPhone>sample string 13</WorkPhone>
  <WorkPhoneExtension>sample string 14</WorkPhoneExtension>
</Contact>