GET/api/v1/contacts
List contacts
Saved contacts your AI greets by name, optionally filtered.
GET
curl "https://app.prepaid.ai/api/v1/contacts?search=aroha" \ -H "Authorization: Bearer $PREPAID_API_KEY"Response · 200
{ "workspaceId": "3f6c1e70-9a4d-4a58-b6a2-2f0f0f9d1c11", "contacts": [ { "id": "5d4c3b2a-1f0e-4d9c-8b7a-6f5e4d3c2b1a", "name": "Aroha Ngata", "phone": "+64211234567", "email": null, "company": null, "notes": "Prefers morning appointments." } ]}Saved contacts, optionally filtered.
Query parameters
- searchstringoptional
- Part of a name, email or company, or at least three digits of a phone number.
- limitintegeroptional
- 1–200, default 50.
Response
- contacts[].idstringalways present
- The contact’s id.
- contacts[].namestringalways present
- Their name.
- contacts[].phonestringalways present
- E.164.
- contacts[].emailstring | nullalways present
- Their email.
- contacts[].companystring | nullalways present
- Their company.
- contacts[].notesstring | nullalways present
- Your standing note about them.