Sign in

v1

latestOpenAPI 3.0.3MIT2026-07-1410794124.7 KB
Contacts

Load Contacts

Returns a list of contacts. Required Access Level: ViewContacts

get/contacts

Query parameters

limitinteger

integer

Maximum number of returned items.

offsetinteger

integer

How many items should be returned ahead.

Response

OK

Emailstring string

Proper email address.

Status'Transactional' | 'Engaged' | 'Active' | 'Bounced' | 'Unsubscribed' | 'Abuse' | 'Inactive' | 'Stale' | 'NotConfirmed'
FirstNamestring string

First name.

LastNamestring string

Last name.

CustomFieldsobject

A key-value collection of custom contact fields which can be used in the system.

Source'DeliveryApi' | 'ManualInput' | 'FileUpload' | 'WebForm' | 'ContactApi' | 'VerificationApi' | 'FileVerificationApi' | 'PilotBillingPlan' | 'PaidNewsletter'
SourceInfostring string
DateAddedstring date-time

Date of creation in YYYY-MM-DDThh:ii:ss format

DateUpdatedstring date-time nullable

Last change date

StatusChangeDatestring date-time nullable

Date of last status change.

Example response

[
  {
    "Email": "mail@example.com",
    "FirstName": "Fred",
    "LastName": "Flintstone",
    "CustomFields": {
      "city": "New York",
      "age": "34"
    },
    "Consent": {
      "ConsentIP": "192.168.0.1",
      "ConsentDate": "1/1/2015 0:00:00 AM"
    },
    "DateAdded": "2001-01-01T12:00:00",
    "DateUpdated": "2001-01-01T12:00:00",
    "StatusChangeDate": "2001-01-01T12:00:00",
    "Activity": {
      "LastOpened": "2014-01-01"
    }
  }
]