GET api/ContactList

Returns a summary list of all contacts in your database. This list is searchable using the OData protocol.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of ContactList

Name	Type	Additional information
ContactId	integer	None.
UnitId	integer	None.
FirstName	string	None.
LastName	string	None.
IsActive	boolean	None.
Username	string	None.
Password	string	None.
CreateDate	date	None.
ModifyDate	date	None.
Links	Collection of Link	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ContactId": 1,
    "UnitId": 2,
    "FirstName": "sample string 3",
    "LastName": "sample string 4",
    "IsActive": true,
    "Username": "sample string 6",
    "Password": "sample string 7",
    "CreateDate": "2026-04-04T00:32:53.8478243-07:00",
    "ModifyDate": "2026-04-04T00:32:53.8478243-07:00",
    "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"
      }
    ]
  },
  {
    "ContactId": 1,
    "UnitId": 2,
    "FirstName": "sample string 3",
    "LastName": "sample string 4",
    "IsActive": true,
    "Username": "sample string 6",
    "Password": "sample string 7",
    "CreateDate": "2026-04-04T00:32:53.8478243-07:00",
    "ModifyDate": "2026-04-04T00:32:53.8478243-07:00",
    "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:

<ArrayOfContactList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProClassApi.Web.Api.Models">
  <ContactList>
    <ContactId>1</ContactId>
    <CreateDate>2026-04-04T00:32:53.8478243-07:00</CreateDate>
    <FirstName>sample string 3</FirstName>
    <IsActive>true</IsActive>
    <LastName>sample string 4</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>
    <ModifyDate>2026-04-04T00:32:53.8478243-07:00</ModifyDate>
    <Password>sample string 7</Password>
    <UnitId>2</UnitId>
    <Username>sample string 6</Username>
  </ContactList>
  <ContactList>
    <ContactId>1</ContactId>
    <CreateDate>2026-04-04T00:32:53.8478243-07:00</CreateDate>
    <FirstName>sample string 3</FirstName>
    <IsActive>true</IsActive>
    <LastName>sample string 4</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>
    <ModifyDate>2026-04-04T00:32:53.8478243-07:00</ModifyDate>
    <Password>sample string 7</Password>
    <UnitId>2</UnitId>
    <Username>sample string 6</Username>
  </ContactList>
</ArrayOfContactList>