GET
/
contact
Get All Contacts
curl --request GET \
  --url https://api.sendx.io/api/v1/rest/contact \
  --header 'X-Team-ApiKey: <api-key>'
[
  {
    "id": "a1b2c3d4e5",
    "firstName": "Jane",
    "lastName": "Doe",
    "email": "jane.doe@example.com",
    "company": "Tech Solutions Inc.",
    "customFields": {
      "Position": "VIP",
      "Status": "Special Offer Subscriber"
    },
    "unsubscribed": false,
    "bounced": false,
    "spam": false,
    "created": "2024-10-08T09:30:00Z",
    "updated": "2024-10-08T12:45:00Z",
    "blocked": false,
    "dropped": false,
    "LTV": 5000,
    "contactSource": 8,
    "lastTrackedIp": "192.168.0.1",
    "lists": [
      "sendx123",
      "sendx233"
    ],
    "tags": [
      "223",
      "3232"
    ]
  }
]

Authorizations

​
X-Team-ApiKey
string
header
required

Query Parameters

​
offset
integer
default:0

Offset for pagination

​
limit
integer
default:10

Limit for pagination

​
contactType
enum<string>

Filter contacts by type

Available options:
all,
unsubscribed,
bounced,
markedspam
​
search
string

Search term to filter contacts

Response

200
application/json

List of Contacts

The response is of type object[].