List Contacts

Number of contacts per page (defaults to 25).

Page number for pagination (defaults to 1).

Comma-separated list of relations to include in the response. Allowed values: locals, profile_picture, suppliers, user, extensions_permissions.

Sort results by one or more fields. Allowed fields: name, email. Use a comma-separated list for multiple sorts and prefix a field with "-" for descending order. The alias "sorts" is also supported.

Filter by a specific contact ID.

Comma-separated list of contact IDs to include.

Comma-separated list of contact IDs to exclude.

Filter by the exact email address.

Filter contacts whose email contains the provided value (case-insensitive).

Comma-separated list of email addresses to exclude.

Filter by the exact contact name.

Filter contacts whose name contains the provided value (case-insensitive).

Filter by the contact phone number.

Filter by the has_access field (can be 1 or 0).

Filters only contacts who have access to the Direct portal.

Filter contacts associated with the provided client ID.

Scope results to contacts that have a non-empty email address (flag parameter, any value).