curl --request GET \
--url 'https://api.peoplewisher.com/v1/contacts?page=1&per_page=100' \
--header 'Authorization: Bearer YOUR_API_KEY'
{
"success": true,
"data": [
{
"contact_id": 4812,
"first_name": "Ada",
"last_name": "Okafor",
"email": "[email protected]",
"phone": "+2348012345678",
"whatsapp_phone": "+2348012345678",
"profile_image": null,
"contact_status": "1",
"birthday_month": 10,
"birthday_day": 12,
"birthday_year": 1994,
"gender": null,
"location": "Lagos",
"timezone": "Africa/Lagos",
"language": "en",
"company": "Example Ltd",
"job_title": "Finance Manager",
"salutation": "Ms.",
"relationship_status": null,
"group_id": 24,
"group_name": "Customers",
"guardian_contact_id": null,
"source": "api",
"date_created": "2026-09-28 17:30:00",
"date_updated": null
}
],
"todays_date": "28-09-2026",
"fetched_record": 1,
"total_records": 1,
"page": 1,
"per_page": 100,
"has_more": false,
"birthday_status": true
}
API Reference
List contacts
Retrieve contacts from your Peoplewisher account. You can filter by Celebration Group, search, and paginate through results.
GET
/
contacts
curl --request GET \
--url 'https://api.peoplewisher.com/v1/contacts?page=1&per_page=100' \
--header 'Authorization: Bearer YOUR_API_KEY'
{
"success": true,
"data": [
{
"contact_id": 4812,
"first_name": "Ada",
"last_name": "Okafor",
"email": "[email protected]",
"phone": "+2348012345678",
"whatsapp_phone": "+2348012345678",
"profile_image": null,
"contact_status": "1",
"birthday_month": 10,
"birthday_day": 12,
"birthday_year": 1994,
"gender": null,
"location": "Lagos",
"timezone": "Africa/Lagos",
"language": "en",
"company": "Example Ltd",
"job_title": "Finance Manager",
"salutation": "Ms.",
"relationship_status": null,
"group_id": 24,
"group_name": "Customers",
"guardian_contact_id": null,
"source": "api",
"date_created": "2026-09-28 17:30:00",
"date_updated": null
}
],
"todays_date": "28-09-2026",
"fetched_record": 1,
"total_records": 1,
"page": 1,
"per_page": 100,
"has_more": false,
"birthday_status": true
}
curl --request GET \
--url 'https://api.peoplewisher.com/v1/contacts?page=1&per_page=100' \
--header 'Authorization: Bearer YOUR_API_KEY'
{
"success": true,
"data": [
{
"contact_id": 4812,
"first_name": "Ada",
"last_name": "Okafor",
"email": "[email protected]",
"phone": "+2348012345678",
"whatsapp_phone": "+2348012345678",
"profile_image": null,
"contact_status": "1",
"birthday_month": 10,
"birthday_day": 12,
"birthday_year": 1994,
"gender": null,
"location": "Lagos",
"timezone": "Africa/Lagos",
"language": "en",
"company": "Example Ltd",
"job_title": "Finance Manager",
"salutation": "Ms.",
"relationship_status": null,
"group_id": 24,
"group_name": "Customers",
"guardian_contact_id": null,
"source": "api",
"date_created": "2026-09-28 17:30:00",
"date_updated": null
}
],
"todays_date": "28-09-2026",
"fetched_record": 1,
"total_records": 1,
"page": 1,
"per_page": 100,
"has_more": false,
"birthday_status": true
}
How it works
Query parameters
group_id— Return only contacts belonging to a specific Celebration Group.page— Page number. Peoplewisher returns up to 100 contacts per page.search— Search contacts using the fields supported by PeopleWisher.
has_more field to determine whether another page is available.
Authentication
Include your Peoplewisher API key as a Bearer token on every request:Authorization: Bearer YOUR_API_KEY
Authorizations
Use the API key generated in Peoplewisher Settings as a Bearer token.
Query Parameters
Restrict the contact list to a Celebration Group.
Required range:
x >= 1Page number. Results contain up to 100 contacts.
Required range:
x >= 1Search contacts by the fields supported by PeopleWisher.