Sign in

v4

latestOpenAPI 3.1.02026-07-3163216290.7 KB
Contacts

Find a contact

Search for a contact by email or userId. Only one parameter is allowed.

get/v1/contacts/find

Query parameters

emailstring

Email address (URI-encoded)

userIdstring

Response

List of contacts (or an empty array if no contact was found). Contact objects will include any custom properties.

idstring

The contact's Loops ID.

emailstring

The contact's email address.

firstNamestring nullable

The contact's first name.

lastNamestring nullable

The contact's last name.

sourcestring

The source the contact was created from.

subscribedboolean

Whether the contact will receive campaign and workflow emails.

userGroupstring

The contact's user group.

userIdstring nullable

The contact's unique user ID.

mailingListsobject

Mailing lists the contact is subscribed to, represented by key-value pairs of mailing list IDs and true.

optInStatus'accepted' | 'pending' | 'rejected' | 'null' nullable

Double opt-in status. This will be null for contacts unless they are created via a form while double opt-in is enabled.

Example response

[
  {
    "id": "clh3k9m2p4q6r8s0t2v4x6z8",
    "email": "alex@company.com",
    "firstName": "Alex",
    "lastName": "Rivera",
    "source": "API",
    "subscribed": true,
    "userGroup": "customers",
    "userId": "usr_7f8e9d0c1b2a",
    "mailingLists": {
      "clm2k8j4h6g0f8d6s4a2b0z8": true
    },
    "optInStatus": "accepted"
  }
]