API Reference

Search across customers and contacts

get
https://api.heymantle.com/v1/entities

Search across both customers and contacts indexes. Returns a mixed list of entities with their type indicated.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
Defaults to 0

The page number to retrieve

integer
Defaults to 25

The number of records to retrieve

string

The search term to filter by

type
array of strings

Filter by entity type. Can be specified multiple times.

type
tags
array of strings

Filter by tags. Can be specified multiple times.

tags
source
array of strings

Filter by source. Can be specified multiple times.

source
listIds
array of strings

Filter by list membership. Returns entities in any of the specified lists. Can be specified multiple times.

listIds
string
enum
Defaults to updatedAt

Field to sort by

Allowed:
string
enum
Defaults to desc

Sort direction

Allowed:
string

Cursor for pagination. Use the cursor from the previous response to get the next page.

Responses

Updated 4 months ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago