/persons.json

Returns a collection of persons that fits to a given criteria array.

📘

Pagination

Maximum is 100 entries, use the page parameter to get the next results.

(with pagination: /persons.xml?page={page_number})

Filter by criteria

/persons.json?search_id=123

Returns a collection of persons that fits to the given criteria.

These criteria are currently available:

Criterion

Description

Type

salutation

The salutation

Enum ( "Mr.", "Mrs.", "Miss", "Ms.", "couple", "family", "diverse")

first_name

The first name

string

last_name

The last name

string

company

The company name

string

phone

A phone number

string

email

An email address

string

address

A part of the address (street, city or post code)

string

tag_ids (separated by comma)

A comma separated list of tag IDs

string

ids (separated by comma)

A comma separated list of IDs

string

search_id

The ID of a smart search

integer

📘

If no persons with these criteria exist, an empty persons container will be returned.

Language
Authentication
Basic
base64
:
Click Try It! to start a request and see the response here!