1. v3
  2. Contacts
  3. GET - 3/contacts/{contactid}

Definition

GET - 3/contacts/{contactId}

Retrieve a contact by id.

Required roles: Contacts (read)

Request information

contactId

The id of the contact.


Type integer
Additional info
Required

Response information

Available information for this contact.


Meta

The metadata such as paging parameters, status code, timestamp,... which are related to this request.


Type MetaData
Data

The actual data returned by the request.


Type Contact
Links

HATEOAS related to this object. It wil contain relevant url's such as previous and next page for paged results, create/update/delete action. These url's can be used in your application for the next steps in your application logic.


Type Hateoas

Sample: 
{
  "Meta": {
    "Status": 1,
    "TotalRowCount": 1,
    "Limit": 1,
    "Offset": 1,
    "TotalPageCount": 1,
    "StartRec": 1,
    "StopRec": 1,
    "Timestamp": "2024-12-21T17:00:28.4398822Z",
    "IsFiltered": true
  },
  "Data": {
    "LangCode": "en",
    "Surveys": [
      {
        "SurveyId": 2,
        "Title": "sample string 3",
        "PanelistStatusId": 4,
        "DateAdded": "2024-12-21T17:00:28.4419265Z",
        "PanelistReportUrl": "sample string 5"
      },
      {
        "SurveyId": 2,
        "Title": "sample string 3",
        "PanelistStatusId": 4,
        "DateAdded": "2024-12-21T17:00:28.4419265Z",
        "PanelistReportUrl": "sample string 5"
      }
    ],
    "Groups": [
      {
        "GroupId": 2,
        "Name": "sample string 3"
      },
      {
        "GroupId": 2,
        "Name": "sample string 3"
      }
    ],
    "ContactId": 1,
    "FirstName": "John",
    "LastName": "Doe",
    "Email": "john.doe@mail.com",
    "CustomField1": "sample string 2",
    "CustomField2": "sample string 3",
    "CustomField3": "sample string 4",
    "CustomField4": "sample string 5",
    "CustomField5": "sample string 6",
    "CustomField6": "sample string 7",
    "CustomField7": "sample string 8",
    "CustomField8": "sample string 9",
    "CustomField9": "sample string 10",
    "CustomField10": "sample string 11",
    "CustomField11": "sample string 12",
    "CustomField12": "sample string 13",
    "CustomField13": "sample string 14",
    "CustomField14": "sample string 15",
    "CustomField15": "sample string 16",
    "CustomField16": "sample string 17",
    "CustomField17": "sample string 18",
    "CustomField18": "sample string 19",
    "CustomField19": "sample string 20",
    "CustomField20": "sample string 21",
    "Street": "Main Street",
    "HouseNumber": "123",
    "Suite": "B",
    "PostalCode": "98765-4321",
    "City": "Anytown",
    "State": "CA",
    "Province": "Orange County",
    "Phone": "+1-202-555-0117",
    "CountryId": "US",
    "Gender": "M",
    "DateOfBirth": "2024-12-21T17:00:28.4408832Z",
    "IsBounced": true,
    "IsOptedOut": true
  }
}
Sample: 
<Payload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
  <Data z:Id="i2">
    <Groups>
      <GroupReference>
        <GroupId>2</GroupId>
        <Name>sample string 3</Name>
      </GroupReference>
      <GroupReference>
        <GroupId>2</GroupId>
        <Name>sample string 3</Name>
      </GroupReference>
    </Groups>
    <LangCode>en</LangCode>
    <Surveys>
      <SurveyReference z:Id="i3">
        <DateAdded>2024-12-21T17:00:28.4419265+00:00</DateAdded>
        <PanelistReportUrl>sample string 5</PanelistReportUrl>
        <PanelistStatusId>4</PanelistStatusId>
        <SurveyId>2</SurveyId>
        <Title>sample string 3</Title>
      </SurveyReference>
      <SurveyReference z:Ref="i3" />
    </Surveys>
    <ContactId>1</ContactId>
    <FirstName>John</FirstName>
    <LastName>Doe</LastName>
    <Email>john.doe@mail.com</Email>
    <CustomField1>sample string 2</CustomField1>
    <CustomField2>sample string 3</CustomField2>
    <CustomField3>sample string 4</CustomField3>
    <CustomField4>sample string 5</CustomField4>
    <CustomField5>sample string 6</CustomField5>
    <CustomField6>sample string 7</CustomField6>
    <CustomField7>sample string 8</CustomField7>
    <CustomField8>sample string 9</CustomField8>
    <CustomField9>sample string 10</CustomField9>
    <CustomField10>sample string 11</CustomField10>
    <CustomField11>sample string 12</CustomField11>
    <CustomField12>sample string 13</CustomField12>
    <CustomField13>sample string 14</CustomField13>
    <CustomField14>sample string 15</CustomField14>
    <CustomField15>sample string 16</CustomField15>
    <CustomField16>sample string 17</CustomField16>
    <CustomField17>sample string 18</CustomField17>
    <CustomField18>sample string 19</CustomField18>
    <CustomField19>sample string 20</CustomField19>
    <CustomField20>sample string 21</CustomField20>
    <Street>Main Street</Street>
    <HouseNumber>123</HouseNumber>
    <Suite>B</Suite>
    <PostalCode>98765-4321</PostalCode>
    <City>Anytown</City>
    <State>CA</State>
    <Province>Orange County</Province>
    <Phone>+1-202-555-0117</Phone>
    <CountryId>US</CountryId>
    <Gender>M</Gender>
    <DateOfBirth>2024-12-21T17:00:28.4408832+00:00</DateOfBirth>
    <IsBounced>true</IsBounced>
    <IsOptedOut>true</IsOptedOut>
  </Data>
  <Meta>
    <IsFiltered>true</IsFiltered>
    <Limit>1</Limit>
    <Offset>1</Offset>
    <StartRec>1</StartRec>
    <Status>1</Status>
    <StopRec>1</StopRec>
    <Timestamp>2024-12-21T17:00:28.4398822+00:00</Timestamp>
    <TotalPageCount>1</TotalPageCount>
    <TotalRowCount>1</TotalRowCount>
  </Meta>
</Payload>

Related Examples

Title
Add a new contact to a survey