Get customers by email

Return a list of people in your workspace matching an email address.

If the email contains special characters like +, make sure you percent-encode them in the query parameter. For example, use jane%2Bnotifications%40example.com instead of jane+notifications@example.com. Unencoded special characters can return empty results without an error.

get/v1/customers

Query parameters

emailstring email required

The email address you want to search for.

Response

Returns an array of results; each result represents a person.

Example response

{
  "results": [
    {
      "email": "hugh.mann@example.com",
      "cio_id": "a3000001"
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.