COcopper
People

Fetch a person by email

Email address is a unique key for People records in Copper. You can fetch a Person by its email address using this operation. This endpoint is eligible to return computed custom field values.

post/people/fetch_by_email

Request

  • Base URL
    https://api.copper.com/developer_api/v1
  • Auth
    HTTP bearer

Query parameters

custom_field_computed_valuesboolean

When true, returns computed custom field values (human-readable labels) in addition to option IDs for Dropdown and Multi-select fields. The response will include a 'computed_value' field alongside the 'value' field in custom_fields array.

Request body

emailstring email required

The email address to search for

Example request

{
  "email": "mycontact_123@noemail.com"
}

Response

Person retrieved successfully

idinteger required

Unique identifier for the person

namestring required

The first and last name of the person

prefixstring nullable

Name prefix

first_namestring

First name of the person

middle_namestring nullable

Middle name of the person

last_namestring

Last name of the person

suffixstring nullable

Name suffix

assignee_idinteger nullable

Unique identifier of the user that will be the owner of the person

company_idinteger nullable

ID of the associated company

company_namestring nullable

Name of the associated company

contact_type_idinteger

Unique identifier of the contact type

detailsstring nullable

Description of the person

tagsstring[]

An array of the tags associated with the person

titlestring nullable

The professional title of the person

date_createdinteger

A Unix timestamp representing the time at which this person was created

date_modifiedinteger

A Unix timestamp representing the time at which this person was last modified

date_last_contactedinteger nullable

A Unix timestamp representing the time at which this person was last contacted

interaction_countinteger

The number of interactions with this person

leads_converted_frominteger[]

An array of lead IDs that were converted to this person

date_lead_createdinteger nullable

A Unix timestamp representing when the lead was created before conversion

Example response

{
  "id": 27140442,
  "name": "My Contact",
  "first_name": "My",
  "last_name": "Contact",
  "address": {
    "street": "213 West Main Street",
    "city": "Scranton",
    "state": "PA",
    "postal_code": "18501"
  },
  "company_id": 3,
  "company_name": "Dunder Mifflin (sample)",
  "contact_type_id": 451492,
  "emails": [
    {
      "email": "mycontact_123@noemail.com",
      "category": "work"
    }
  ],
  "phone_numbers": [
    {
      "number": "415-123-45678",
      "category": "mobile"
    }
  ],
  "socials": [
    {
      "url": "facebook.com/person",
      "category": "facebook"
    }
  ],
  "tags": [],
  "title": "Regional Manager",
  "websites": [
    {
      "url": "http://www.dundermifflin.com/index.shtml",
      "category": "work"
    }
  ],
  "custom_fields": [
    {
      "custom_field_definition_id": 100764
    }
  ],
  "date_created": 1490045413,
  "date_modified": 1490045413,
  "leads_converted_from": []
}

Changes

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