Search endpoint for contacts

Returns a paginated list of contacts. This endpoint can fetch up to 50,000 records. Use /v2/clients/scroll when you need to iterate over larger result sets.

Search and filters

• q - Searches by contact name, company, email, address, description, warning notice, and phone-like input
• phone_number - Searches by exact telephone number. Spaces and hyphens do not matter
• property_ids - Finds contacts linked to one or more properties
• client_status_id - Finds contacts by client status ID
• group_ids - Finds contacts assigned to one or more client group IDs
• broker_id - Finds contacts by responsible broker ID
• team_id - Finds contacts by team ID
• updated_at_from - Finds contacts updated at or after this date
• updated_at_to - Finds contacts updated at or before this date

All results are scoped to the authenticated shop. Unknown IDs or IDs that do not belong to that shop simply return no matching contacts.

Pagination and response shape

• page - Page number. Defaults to 1
• per - Number of contacts per page. Defaults to 10, maximum 1000
• with_total - Set to true to include the total matching count
• fields - Comma-separated list of response fields to include

Filtering for empty/null values on custom fields

To filter records where a custom field is empty or not empty, use these special values:

• __empty__ - Finds records where the field is null, not set, or equals an empty string
• __not_empty__ - Finds records where the field exists and has a value

Examples

Find contacts by search query: https://api.propstack.de/v2/clients?q=smith

Find contacts by client status: https://api.propstack.de/v2/clients?client_status_id=123

Find contacts assigned to any of the given groups: https://api.propstack.de/v2/clients?group_ids=1,2

Find contacts by responsible broker: https://api.propstack.de/v2/clients?broker_id=45

Find contacts by team: https://api.propstack.de/v2/clients?team_id=9

Find contacts linked to properties: https://api.propstack.de/v2/clients?property_ids=10,11

Return only selected fields: https://api.propstack.de/v2/clients?fields=id,first_name,last_name,email

Find contacts where custom field "rating" is empty: ?cf_rating=__empty__

Find contacts where custom field "notes" has a value: ?cf_notes=__not_empty__

If the telephone number 0157 123 456 78 is stored with a contact, the following enquiries can be made:

https://api.propstack.de/v2/clients?phone_number=015712345678 or https://api.propstack.de/v2/clients?phone_number=0157-123-456-78