Skip to content

Fetch a Person by Email

POST https://api.prosperworks.com/developer_api/v1/people/fetch_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.

Request Body

1
2
3
{
  "email": "mycontact_123@noemail.com"
}

Example Requests

Fetch by Email

1
2
3
4
5
6
7
8
curl --location --request POST "https://api.prosperworks.com/developer_api/v1/people/fetch_by_email" \
  --header "X-PW-AccessToken: YOUR_TOKEN_HERE" \
  --header "X-PW-Application: developer_api" \
  --header "X-PW-UserEmail: YOUR_EMAIL_HERE" \
  --header "Content-Type: application/json" \
  --data "{
    \"email\": \"mycontact_123@noemail.com\"
}"
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
{
  "id": 27140442,
  "name": "My Contact",
  "prefix": null,
  "first_name": "My",
  "middle_name": null,
  "last_name": "Contact",
  "suffix": null,
  "address": null,
  "assignee_id": null,
  "company_id": null,
  "company_name": null,
  "contact_type_id": 451492,
  "details": null,
  "emails": [
    {
      "email": "mycontact_123@noemail.com",
      "category": "work"
    }
  ],
  "phone_numbers": [
    {
      "number": "415-123-45678",
      "category": "mobile"
    }
  ],
  "socials": [],
  "tags": [],
  "title": null,
  "websites": [],
  "custom_fields": [
    {
      "custom_field_definition_id": 100764,
      "value": null
    },
    {
      "custom_field_definition_id": 103481,
      "value": null
    }
  ],
  "date_created": 1490045413,
  "date_modified": 1490045413,
  "interaction_count": 0
}