API documentation

Listing active people

Retrieve all active people for your account. Active people are all people who have not unsubscribed or bounced.

Results are returned in the order in which they were created. See the parameters section below for more information regarding pagination.

You can search for specific people by passing either an email or a phone_number parameter (but not both). The results are returned as a list, which will be empty if no matching people were found.

Endpoint

GET /v1/people.json

Example request

curl https://api.delighted.com/v1/people.json \
  -u YOUR_DELIGHTED_API_KEY:

Example response

[
  {
    "id": "1",
    "email": "gabriel.larson@simsarnold.com",
    "name": "Gabriel Larson",
    "created_at": 1551114774,
    "phone_number": "+17132746524",
    "last_sent_at": 1552579974,
    "last_responded_at": 1553184774,
    "next_survey_scheduled_at": 1561479174
  }
]

Parameters

Name Type Description
per_page Integer Number of results to return per page. The default is 20. The maximum is 100.
page Integer The page number to return. The default is 1.
since Integer An optional Unix timestamp to restrict the list to people created on or after this time. Formatting example (for 1 hour ago): 1556205174.
until Integer An optional Unix timestamp to restrict the list to people created on or before this time. Formatting example (for the current time): 1556208774.
email String An optional email to restrict results to a specific person.
phone_number String

An optional phone number to restrict results to a specific person.

The phone number format must be E.164 (e.g. +17132746524). The value should start with a + followed by the country code and then the number. The value should contain only + and digits, no spaces or other punctuation.