Search profiles in the app and the API
Use search profiles on your phone, and read them from another system with an API key.
The IDup app shows the same search profiles as the web. The API lets another system read them.
Where to find itApp → Search profiles; web: API → API guide
In the app
- Four tabs: Overview, Statistics, Matches and Forms.
- Open a profile to see details, matches with reasons and the history.
- Pause, resume or mark it Done, add a note, or send a property.
- New search profile offers IDup AI or manual entry.
- Under Forms you share the link or QR code from your phone, and create a form in the same steps as on the web.
- Select rows to delete, restore or delete permanently, as described in Trash, unsubscribe and deletion.
The entry only appears if the module is switched on for your company.
In the API
Two read-only areas exist. Your plan must include the module.
- GET /api/search_profiles lists search profiles. Filters: status, goal, source, channel and form_id.
- GET /api/search_profiles/{id} returns one profile with its criteria and matches.
- GET /api/search_profiles/search/{keyword} searches name, email, phone and place.
- GET /api/search_profile_stats returns summed figures for a period.
Send your key in the header authtoken. Create keys as described in API keys and the API.
Personal dataReading search profiles gives access to contact details. Give such a key only to systems that may process this data. The trash is never part of the API.
Was this article helpful?
Nothing is tracked — the buttons only open a message so you can tell us what was missing.
