Find contact

Find a contact by email address or user ID.

GET https://app.loops.so/api/v1/contacts/find

Find contact

cURL

curl --request GET \
  --url https://app.loops.so/api/v1/contacts/find \
  --header 'Authorization: Bearer <token>'

Response

[
  {
    "id": "cll6b3i8901a9jx0oyktl2m4u",
    "email": "[e-mail]",
    "firstName": "Bob",
    "lastName": null,
    "source": "API",
    "subscribed": true,
    "userGroup": "",
    "userId": null,
    "mailingLists": {
      "cm06f5v0e45nf0ml5754o9cix": true
    },
    "optInStatus": "accepted"
  }
]

Request

Query parameters

Search by email or user ID. Only one parameter is allowed.

email · string

The contact’s email address. Make sure it is URI-encoded.

userId · string

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.

Contacts · array

Hide properties

id · string

The contact’s Loops-assigned ID.

email · string

The contact’s email address.

firstName · string

The contact’s first name.

lastName · string

The contact’s last name.

source · string

The source the contact was created from.

subscribed · boolean

Whether the contact will receive campaign and loops emails.

userGroup · string

The contact’s user group.

userId · string

The contact’s unique user ID.

mailingLists · object

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

optInStatus · string

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

[
  {
    "id": "cll6b3i8901a9jx0oyktl2m4u",
    "email": "[e-mail]",
    "firstName": "Bob",
    "lastName": null,
    "source": "API",
    "subscribed": true,
    "userGroup": "",
    "userId": null,
    "mailingLists": {
      "cm06f5v0e45nf0ml5754o9cix": true
    },
    "optInStatus": "accepted"
  }
]