Get Contact

Overview

Retrieves details of an existing contact from a specified list.

Authentication

This request requires a Authorization header with a valid token.

URL: POST https://api3.blocksurvey.io/contact/get-contact

Request Body

Field	Type	Required	Description
teamId	String	Yes	ID of the team owning the list.
listId	String	Yes	ID of the list containing contact.
listPrivateKey	String	Yes	Private key for decryption.
recordId	String	No	ID of the contact to retrieve or update (optional).
Email	String	No	Email of the contact (optional), but required if recordId is not provided.

cURL Example

curl -X GET https://api3.blocksurvey.io/contact/get-contact
-H "Authorization: Bearer your-api-key" \
-H "Content-Type: application/json" \
-d '{
    "teamId": "team-123",
    "listId": "list-456",
    "listPrivateKey": "base64-private-key",
    "Email": "[email protected]"
}'

Response

Successful Response

Success (200)
{
    "success": true,
    "contactDetails": 
    {
       "Email": "[email protected]",
       “First Name”:  “John”,
       “Last Name”: “Doe”,
       “Phone Number”: “123 456 789 0”,
       “Country”: “US”   
       }
}