Get all contacts
Retrieves a paginated list of all contacts in your team with optional filtering capabilities.
🎯 Key Features:
- Pagination support with offset/limit
- Search contacts by name or email
- All relationships included (lists, tags, custom fields)
- Prefixed IDs for easy integration
📊 Pagination:
- Default limit: 10 contacts per page
- Maximum limit: 100 contacts per page
- Use offset for page navigation
🔍 Search:
- Searches across firstName, lastName, and email fields
- Case-insensitive partial matching
- Combine with pagination for large datasets
Authorizations
Team API key for authentication. Find your API key in SendX Settings → Team API Key.
Example:
X-Team-ApiKey: your_team_api_key_hereQuery Parameters
Number of records to skip for pagination.
Examples:
0- First page (default)50- Second page (with limit=50)100- Third page (with limit=50)
x >= 0Maximum number of records to return.
Constraints:
- Minimum: 1
- Maximum: 100
- Default: 10
1 <= x <= 30Search term to filter contacts by name or email.
Search Behavior:
- Searches firstName, lastName, and email fields
- Case-insensitive partial matching
- Minimum 2 characters for search
Examples:
john- Finds "John Doe", "johnson@example.com"@company.com- Finds all emails from company.comsmith- Finds "John Smith", "smith@email.com"
2 - 255Response
✅ Contacts retrieved successfully
Unique contact identifier with contact_ prefix.
Format: contact_ + 22 alphanumeric characters
Usage:
- Use this ID for all subsequent API calls
- Unique across the entire SendX platform
- Never changes once created
^contact_[a-zA-Z0-9]{22}$"contact_BnKjkbBBS500CoBCP0oChQ"
First name of the contact
"John"
Last name of the contact
"Doe"
Email address of the contact (unique within team)
"john.doe@example.com"
Company name of the contact
"Example Corp"
Custom fields with custom_field_ prefixed keys.
Format: All keys have custom_field_ prefix in responses
Example Structure:
{
"field_MnuqBAG2NPLm7PZMWbjQxt": "Engineering",
"field_QqfhckbdcvQinLPlduIbHq": "Senior",
"field_MnuqBAG2NPLm7PZMWbjQxt": "$75000"
}{
"field_MnuqBAG2NPLm7PZMWbjQxt": "Engineering",
"field_QqfhckbdcvQinLPlduIbHq": "Senior"
}Associated lists with list_ prefixed identifiers.
Format: All IDs have list_ prefix in responses
^list_[a-zA-Z0-9]{22}$[
"list_OcuxJHdiAvujmwQVJfd3ss",
"list_xyz789ghi012"
]Associated tags with tag_ prefixed identifiers.
Format: All IDs have tag_ prefix in responses
^tag_[a-zA-Z0-9]{22}$[
"tag_UhsDkjL772Qbj5lWtT62VK",
"tag_UhsDkjL772Qbj5lWtT62VK"
]Whether the contact has unsubscribed from emails
false
Whether emails to this contact have bounced
false
Whether the contact has marked emails as spam
false
Whether the contact is blocked from receiving emails
false
Whether emails to this contact have been dropped
false
Contact creation timestamp (ISO 8601 format)
"2024-01-10T14:20:00Z"
Contact last update timestamp (ISO 8601 format)
"2024-01-15T09:15:00Z"
Email tracking data and UTM parameters.
Contains:
- UTM parameters from campaigns
- Attribution data
- Custom tracking parameters
"utm_source=website&utm_campaign=signup&utm_medium=banner"
Source type of the contact creation.
Values:
1- API/Manual2- Import3- Form4- Integration
1
URL of the page where contact was created
"https://example.com/signup?ref=google-ads"
Last tracked IP address of the contact
"203.0.113.42"
Lifetime Value of the contact in cents.
Example: 7500 = $75.00
7500