Request
Query parameters
Search by email or user ID. Only one parameter is allowed.
The contact’s email address. Make sure it is
URI-encoded .
The contact’s unique user ID.
Response
This endpoint will return a list of contact objects containing all default properties and any custom properties .
If no contact is found, an empty list will be returned.
The contact’s Loops-assigned ID.
The contact’s email address.
The contact’s first name.
The source the contact was created from.
Whether the contact will receive campaign and loops emails.
The contact’s user group.
The contact’s unique user ID.
Mailing lists the contact is subscribed to, represented by key-value pairs of mailing list IDs and true
.
The contact’s double opt-in status.
One of: "pending"
, "accepted"
, "rejected"
or null
. This will be null
for contacts unless they are created via a form while double opt-in is enabled.
Response
No contact found response
[
{
"id" : "cll6b3i8901a9jx0oyktl2m4u" ,
"email" : "[email protected] " ,
"firstName" : "Bob" ,
"lastName" : null ,
"source" : "API" ,
"subscribed" : true ,
"userGroup" : "" ,
"userId" : null ,
"mailingLists" : {
"cm06f5v0e45nf0ml5754o9cix" : true
},
"optInStatus" : "accepted"
}
]