/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:

CriterionDescriptionType
salutationThe salutationEnum ( "Mr.", "Mrs.", "Miss", "Ms.", "couple", "family", "diverse")
first_nameThe first namestring
last_nameThe last namestring
companyThe company namestring
phoneA phone numberstring
emailAn email addressstring
addressA part of the address (street, city or post code)string
tag_ids (separated by comma)A comma separated list of tag IDsstring
ids (separated by comma)A comma separated list of IDsstring
search_idThe ID of a smart searchinteger

📘

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

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