GET api/v1/Contacts?token={token}&page={page}&pageSize={pageSize}
Get a list of contacts
Request Information
URI Parameters
| Name | Description | Type/Additional information |
|---|---|---|
| token | string | |
| page |
The page you want. The default is 0. Each page contains pageSize records |
int32
Default value is 0 |
| pageSize |
The number of records in each page. The default is 50. |
int32
Default value is 50 |
Body Parameters
None.
Response Description
A CaspitResponse containing a list of CaspitContacts
A generic object used to return information from Caspit
Response Formats
application/json, text/json
Sample:
{
"CurrentPage": 1,
"TotalCount": 2,
"TotalPages": 3,
"PrevPageUrl": "sample string 4",
"NextPageUrl": "sample string 5",
"Results": [
{
"DateCreated": "2025-11-01T20:11:35.3417386+02:00",
"UserCreated": "sample string 1",
"DateUpdated": "2025-11-01T20:11:35.3417386+02:00",
"UserUpdated": "sample string 2"
},
{
"DateCreated": "2025-11-01T20:11:35.3417386+02:00",
"UserCreated": "sample string 1",
"DateUpdated": "2025-11-01T20:11:35.3417386+02:00",
"UserUpdated": "sample string 2"
}
]
}
application/xml, text/xml
Sample:
<CaspitResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.caspit.biz/2013/03">
<CurrentPage>1</CurrentPage>
<NextPageUrl>sample string 5</NextPageUrl>
<PrevPageUrl>sample string 4</PrevPageUrl>
<Results>
<CaspitBase>
<DateCreated>2025-11-01T20:11:35.3417386+02:00</DateCreated>
<DateUpdated>2025-11-01T20:11:35.3417386+02:00</DateUpdated>
<UserCreated>sample string 1</UserCreated>
<UserUpdated>sample string 2</UserUpdated>
</CaspitBase>
<CaspitBase>
<DateCreated>2025-11-01T20:11:35.3417386+02:00</DateCreated>
<DateUpdated>2025-11-01T20:11:35.3417386+02:00</DateUpdated>
<UserCreated>sample string 1</UserCreated>
<UserUpdated>sample string 2</UserUpdated>
</CaspitBase>
</Results>
<TotalCount>2</TotalCount>
<TotalPages>3</TotalPages>
</CaspitResponse>