Get Emails

Complex Usage Example

Advanced Email Filtering with Full Context

This example demonstrates advanced filtering with multiple parameters, relationship inclusion, sorting, and pagination:

curl -X GET "https://api.well.com/v1/emails?include=persons,companies,workspaces&filter[company_id]=550e8400-e29b-41d4-a716-446655440000&filter[is_verified]=true&filter[label]=work&filter[created_at_from]=2023-01-01T00:00:00Z&filter[created_at_to]=2023-12-31T23:59:59Z&sort=-created_at&page[limit]=10&page[cursor]=eyJjcmVhdGVkX2F0IjoiMjAyMy0xMS0wMlQxMDozMDowMFoiLCJpZCI6ImVtYWlsOS11dWlkIn0=" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Headers

Authorization

string

required

Bearer token for authentication

Query Parameters

include

string

Comma-separated list of related resources to include with detailed attributes. Available options: persons, companies, workspaces

created_at_from

string<date-time>

Filter emails created on or after this datetime (ISO 8601 format)

created_at_to

string<date-time>

Filter emails created on or before this datetime (ISO 8601 format)

updated_at_from

string<date-time>

Filter emails updated on or after this datetime (ISO 8601 format)

updated_at_to

string<date-time>

Filter emails updated on or before this datetime (ISO 8601 format)

workspace_id

string<uuid>

Filter emails by workspace UUID

external_workspace_id

string

Filter emails by external workspace identifier

people_id

string<uuid>

Filter emails by person UUID

string<email>

Filter by email address

company_id

string<uuid>

Filter by company ID

registration_tax_id

string

Filter by company registration tax ID

registration_registered_value

string

Filter by company registration registered value

is_primary

boolean

default:true

Filter by primary email status

is_verified

boolean

default:true

Filter by verification status

label

enum<string>

default:work

Filter by email label

Available options:

work,

personal,

support,

billing,

other

sort

enum<string>

default:-created_at

Sort emails by date fields. Prefix with '-' for descending order.

Available options:

created_at,

updated_at,

-created_at

page[limit]

integer

default:20

Number of emails to return per page (1-100)

Required range: 1 <= x <= 100

page[cursor]

string

Cursor for pagination to get the next page of results

Response

Emails retrieved successfully

data

object[]

Show child attributes

data.type

string

Allowed value: "email"

data.id

string<uuid>

data.attributes

object

Show child attributes

data.attributes.value

string<email>

Email address value

Example:

"[email protected]"

data.attributes.is_primary

boolean

default:true

Whether this is the primary email address. Defaults to 'false', unless no other email is marked as primary (in which case it becomes 'true'). Only one email can be marked as primary per person/company.

Example:

true

data.attributes.label

enum<string>

default:work

Email label type. See all available labels for complete list.

Available options:

work,

personal,

other,

...

Example:

"work"

data.attributes.created_at

string<date-time>

Timestamp when the email was created

Example:

"2023-06-15T10:30:00Z"

data.attributes.updated_at

string<date-time>

Timestamp when the email was last updated

Example:

"2023-06-15T10:30:00Z"

data.relationships

object

Show child attributes

data.relationships.persons

object

Show child attributes

data.relationships.persons.data

object[]

Show child attributes

data.relationships.persons.data.type

enum<string>

Available options:

people

data.relationships.persons.data.id

string<uuid>

UUID of the people

data.relationships.companies

object

Show child attributes

data.relationships.companies.data

object[]

Show child attributes

data.relationships.companies.data.type

enum<string>

Available options:

company

data.relationships.companies.data.id

string<uuid>

UUID of the company

data.relationships.workspaces

object

Show child attributes

data.relationships.workspaces.data

object[]

Option 1
Option 2

Show child attributes

data.relationships.workspaces.data.type

enum<string>

Available options:

workspace

data.relationships.workspaces.data.external_workspace_id

string

External workspace identifier

data.included

object

Show child attributes

data.included.persons

object

Show child attributes

data.included.persons.data

object[]

Show child attributes

data.included.persons.data.type

string

Allowed value: "people"

data.included.persons.data.id

string<uuid>

data.included.persons.data.attributes

object

Person attribute data

Show child attributes

data.included.persons.data.attributes.first_name

string

required

Person's first name

Required string length: 1 - 100

Example:

"Marie"

data.included.persons.data.attributes.last_name

string

required

Person's last name

Required string length: 1 - 100

Example:

"Dubois"

data.included.persons.data.attributes.created_at

string<date-time>

required

Person creation timestamp (UTC)

Example:

"2024-01-15T10:30:00Z"

data.included.persons.data.attributes.full_name

string

Auto-computed full name (first + last)

Example:

"Marie Dubois"

data.included.persons.data.attributes.updated_at

string<date-time> | null

Last modification timestamp (UTC)

Example:

"2024-01-16T14:20:00Z"

data.included.companies

object

Show child attributes

data.included.companies.data

object[]

Show child attributes

data.included.companies.data.type

string

Allowed value: "company"

data.included.companies.data.id

string<uuid>

data.included.companies.data.attributes

object

Show child attributes

data.included.companies.data.attributes.description

string

data.included.companies.data.attributes.domain_name_primary_link_url

string<url>

The domain url from the website or email address of the company. Used as unique identifier in some cases.

Maximum string length: 500

data.included.companies.data.attributes.tax_id

object

Show child attributes

data.included.companies.data.attributes.tax_id.value

string

Tax ID issued by local or national tax authority.

data.included.companies.data.attributes.tax_id.type

string

Type of tax ID, useful for applying formatting and validation rules.

data.included.companies.data.attributes.registration

object

Show child attributes

data.included.companies.data.attributes.registration.trade_name

string

Commercial or branding name (if different from registered name).

data.included.companies.data.attributes.registration.registered_name

string

Legal company name.

Required string length: 1 - 100

data.included.companies.data.attributes.registration_number

object

Show child attributes

data.included.companies.data.attributes.registration_number.business_type

string

Legal entity structure type.

data.included.companies.data.attributes.registration_number.value

string

Official company registration number.

data.included.companies.data.attributes.registration_number.registry_name

string

Name of the official registration body.

data.included.companies.data.attributes.registration_number.registry_country

string

Country of the registry authority. (string (ISO 3166-1 alpha-2))

data.included.companies.data.attributes.workspace_id

string<uuid>

UUID of the workspace associated with this company

data.included.companies.data.attributes.created_at

string<date-time>

data.included.companies.data.attributes.updated_at

string<date-time>

data.included.workspaces

object

Show child attributes

data.included.workspaces.data

object[]

Show child attributes

data.included.workspaces.data.type

string

Allowed value: "workspace"

data.included.workspaces.data.id

string<uuid>

data.included.workspaces.data.attributes

object

Show child attributes

data.included.workspaces.data.attributes.name

string

Workspace name

data.included.workspaces.data.attributes.desription

string

Workspace description

data.included.workspaces.data.attributes.external_workspace_id

string<uuid>

external workspace id

data.included.workspaces.data.attributes.avatar_color

string<colors>

Color of the avatar

data.included.workspaces.data.attributes.created_at

string<date-time>

Timestamp when the workspace was created

data.included.workspaces.data.attributes.updated_at

string<date-time>

Timestamp when the workspace was last updated

Main Resources

Atomic Resources

System

Complex Usage Example

Advanced Email Filtering with Full Context

Headers

Query Parameters

Response

Main Resources

Atomic Resources

System

​Complex Usage Example

​Advanced Email Filtering with Full Context

Headers

Query Parameters

Response

Complex Usage Example

Advanced Email Filtering with Full Context