Search for emails using specified criteria and filters.

POST /crm/v3/objects/emails/search

Copy endpoint

https://api.hubapi.com

Perform a search for emails based on the provided query parameters and return matching results.

Request Body

application/json required

interface PublicObjectSearchRequest {
after: string;
filterGroups:

FilterGroup

interface FilterGroup {
filters: Filter[];
}

[];
limit: number;
properties: string[];
query?: string;
sorts: string[];
}

Responses

200 application/json

successful operation

interface CollectionResponseWithTotalSimplePublicObject11 {
paging?:

Paging18

interface Paging18 {
next?: NextPage22;
prev?: PreviousPage;
}

;
results:

SimplePublicObject14

A simple public object.

interface SimplePublicObject14 {
archived: boolean;
archivedAt?: string;
createdAt: string;
id: string;
objectWriteTraceId?: string;
properties: { };
propertiesWithHistory?: { };
updatedAt: string;
}

[];
total: number;
}

default */*

An error occurred.

interface Error {
category: string;
context?: { };
correlationId: string;
errors?:

ErrorDetail

interface ErrorDetail {
code?: string;
context?: { };
in?: string;
message: string;
subCategory?: string;
}

[];
links?: { };
message: string;
subCategory?: string;
}