Contact Emails

On this page, we'll dive into the different contact email endpoints you can use to manage them programmatically.

The Contact Email object

Contact email objects represent a single email for a contact related to a commercial risk profile. They contain the following properties and relationships:

Commercial-only Properties

These properties are available only for commercial risk profiles.
  • Name
    contact
    Type
    string
    Filterable
    Description

    The UUID of the contact this email belongs to. Only applicable when creating a new email outside the contacts endpoints.

  • Name
    email
    Type
    string
    Filterable
    Sortable
    Description

    The email for the contact

  • Name
    type
    Type
    enum
    Filterable
    Sortable
    Description

    The type of email

    • Name
      work
      Description
      work
    • Name
      personal
      Description
      personal
    • Name
      other
      Description
      other

Meta

  • Name
    created
    Type
    timestamp
    Filterable
    Sortable
    Description

    An ISO-8601 timestamp (UTC) indicating when the contact email was created

  • Name
    updated
    Type
    timestamp
    Filterable
    Sortable
    Description

    An ISO-8601 timestamp (UTC) indicating when the contact email was last updated

Commercial-only Relations

Learn more about including relations.

GET/api/v1/risks/{risk}/data/contact_emails

List all contact emails

This endpoint allows you to retrieve a paginated list of all contact emails related to contacts in the corresponding commercial risk profile.

Parameters

See the contact email object for a list of all available filters and sorts.

Searchable

You can search for contact emails by providing a search query in the filter[search] parameter. The search query will be matched against the contact email address, and contact first and last names.

Additional Filters

  • Name
    uuid
    Type
    string
    Filterable
    Description

    Filter contact emails by UUID (comma-delimited list for many)

  • Name
    contact
    Type
    string|string[]
    Filterable
    Description

    Filter contact emails by their contact's UUID (comma-delimited list for many)

  • Name
    contact.first_name
    Type
    string
    Filterable
    Sortable
    Description

    Filter contact emails by their contact's first name

  • Name
    contact.last_name
    Type
    string
    Filterable
    Sortable
    Description

    Filter contact emails by their contact's last name

Request

GET
/api/v1/risks/{risk}/data/contact_emails
curl -G https://app.wunderite.com/api/v1/risks/{risk}/data/contact_emails \
-H "Authorization: Bearer {token}" \
-H "Accept: application/json" \
-d per_page=50

Response

{ "data": [ { "object": "contact_email", "uuid": "03ebae86-525e-4d83-9221-03ccb552ddee", "data": { "contact": "6bd2c61e-9840-40b3-9153-1d52379a9b16", "email": "[email protected]", "type": "work" },
"meta": { "created": "2024-04-19T18:57:05+00:00", "updated": "2024-04-19T18:57:05+00:00" }, "relations": { "contact": "6bd2c61e-9840-40b3-9153-1d52379a9b16" } }, { "object": "contact_email", "uuid": "01467093-bd67-47c9-8389-3200c4f14b8b", "data": { "contact": "fefd268c-af53-4099-995f-157a929e46f5", "email": "[email protected]", "type": "work" }, "meta": { "created": "2024-04-19T18:57:05+00:00", "updated": "2024-04-19T18:57:05+00:00" }, "relations": { "contact": "fefd268c-af53-4099-995f-157a929e46f5" } } ], "path": "https:\/\/app.wunderite.com\/api\/v1\/risks\/d10e34bb-4420-47de-ba9f-42a4a3f34b0e\/data\/contact_emails", "per_page": 50, "next_cursor": null, "next_page_url": null, "prev_cursor": null, "prev_page_url": null }