Skip to main content
GET
/
api
/
contacts
List Contacts
curl --request GET \
  --url https://api.example.com/api/contacts

Request

curl "https://app.orova.ai/api/contacts?workspaceId=WORKSPACE_ID&page=1&limit=20" \
  -H "x-api-key: YOUR_API_KEY"

Query parameters

ParameterTypeDefaultDescription
workspaceIdstringFilter by workspace
pagenumber1Page number
limitnumber10Items per page
searchstringSearch by name or phone

Response

{
  "data": [
    {
      "_id": "contact_id",
      "contactName": "John Doe",
      "phoneNumber": "+1234567890",
      "region": "US East",
      "workspaceId": "WORKSPACE_ID"
    }
  ],
  "total": 1,
  "page": 1,
  "limit": 10
}