Search contacts
Find people, companies and suppliers by name, contact ID, company, phone, email or category.
GET https://cotlet.dev/api/v1/vaultre/contacts/search
read
Searches Contacts > Search with the criteria you give; more criteria narrow the result. Each row has the name, company, email, mobile, marketing contacts and last update, the columns Vault shows. Archived contacts stay out unless include_archived is true. Use it before add_contact to avoid a duplicate.
Parameters
| Name | Type | Description |
|---|---|---|
| type enum | enum | person, company or creditor_supplier. |
| name string | string | First name, surname or contact ID. |
| company_name string | string | Company name. |
| phone_or_email string | string | A contact number or an email address. |
| category string | string | A contact category of your account. |
| include_archived boolean | boolean | Also search archived contacts. Default: false. |
| limit integer | integer | Maximum contacts to return. |
| cursor string | string | Next page cursor from the previous call. |
Request
curl https://cotlet.dev/api/v1/vaultre/contacts/search \
-H "Authorization: Bearer $COTLET_API_KEY"result = client.call("vaultre", "search_contacts")const result = await cotlet.call('vaultre', 'search_contacts');cotlet call vaultre search_contactsExample response
{
"contacts": [
{
"contact_id": "51377",
"type": "person",
"name": "Priya Nair",
"company": null,
"email": "priya.nair@example.com",
"mobile": "0400 000 123",
"marketing_contacts": [
"Sam Reid"
],
"updated_at": "2026-10-20T16:40:00+11:00"
}
],
"next_cursor": null
}