GET api/v1/Contacts?email={email}&token={token}&page={page}

Get contacts by email address
Examples:
GET api/v1/Contacts/?token=_TOKEN_&email=support@caspit.biz
or GET api/v1/Contacts/?token=_TOKEN_&email=support@caspit.biz&page=1
If the contact is not found ==> Exception

Request Information

URI Parameters

NameDescriptionType/Additional information
email

Required. The email address

string

Required

token

The access token

string
page

The page you want. The default is 0. Each page contains 50 records

int32

Default value is 0

Body Parameters

None.

Response Description

A CaspitResponse containing a list of CaspitContacts

CaspitResponse

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": "2022-10-06T23:26:22.9018974+03:00",
      "UserCreated": "sample string 1",
      "DateUpdated": "2022-10-06T23:26:22.9018974+03:00",
      "UserUpdated": "sample string 2"
    },
    {
      "DateCreated": "2022-10-06T23:26:22.9018974+03:00",
      "UserCreated": "sample string 1",
      "DateUpdated": "2022-10-06T23:26:22.9018974+03: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>2022-10-06T23:26:22.9018974+03:00</DateCreated>
      <DateUpdated>2022-10-06T23:26:22.9018974+03:00</DateUpdated>
      <UserCreated>sample string 1</UserCreated>
      <UserUpdated>sample string 2</UserUpdated>
    </CaspitBase>
    <CaspitBase>
      <DateCreated>2022-10-06T23:26:22.9018974+03:00</DateCreated>
      <DateUpdated>2022-10-06T23:26:22.9018974+03:00</DateUpdated>
      <UserCreated>sample string 1</UserCreated>
      <UserUpdated>sample string 2</UserUpdated>
    </CaspitBase>
  </Results>
  <TotalCount>2</TotalCount>
  <TotalPages>3</TotalPages>
</CaspitResponse>