# PeopleWisher

> Developer documentation for the Peoplewisher API.

- [Peoplewisher Developer API](https://developer.peoplewisher.com/index.md): Add Peoplewisher celebration automation to your product by syncing contacts into the right Celebration Groups.
- [Quickstart](https://developer.peoplewisher.com/quickstart.md): Make your first Peoplewisher API request and add a contact to a celebration workflow.
- [Authentication](https://developer.peoplewisher.com/authentication.md): Authenticate Peoplewisher API requests with an API key.
- [Platform model](https://developer.peoplewisher.com/platform-model.md): Understand the boundary between your application and the Peoplewisher celebration engine.
- [Contacts](https://developer.peoplewisher.com/guides/contacts.md): Synchronize the people Peoplewisher should celebrate.
- [Celebration Groups](https://developer.peoplewisher.com/guides/celebration-groups.md): Create, list, and remove the groups that connect contacts to Peoplewisher workflows.
- [List contacts](https://developer.peoplewisher.com/api-reference/contacts-list.md): Retrieve contacts from your Peoplewisher account. You can filter by Celebration Group, search, and paginate through results.
- [Create a contact](https://developer.peoplewisher.com/api-reference/contacts-create.md): Create a contact and assign it to a Celebration Group. Once the contact is in the group, Peoplewisher handles the configured celebration workflow.
- [Update a contact](https://developer.peoplewisher.com/api-reference/contacts-update.md): Update an existing contact in your Peoplewisher account.
- [Delete a contact](https://developer.peoplewisher.com/api-reference/contacts-delete.md): Permanently remove a contact from your Peoplewisher account.
- [List Celebration Groups](https://developer.peoplewisher.com/api-reference/groups-list.md): List the Celebration Groups available to your Peoplewisher account. Each group includes its celebration category so your application can determine where a contact belongs.
- [Create a Celebration Group](https://developer.peoplewisher.com/api-reference/groups-create.md): Create a Celebration Group that contacts can be assigned to.
- [Delete a Celebration Group](https://developer.peoplewisher.com/api-reference/groups-delete.md): Delete a Celebration Group from your Peoplewisher account.
- [Webhooks](https://developer.peoplewisher.com/webhooks/overview.md): Receive Peoplewisher events at your own HTTP endpoint.
- [Delivery-status forwarding](https://developer.peoplewisher.com/webhooks/delivery-status.md): Forward Peoplewisher delivery reports to an HTTP endpoint on Enterprise.
- [Rate limits](https://developer.peoplewisher.com/operations/rate-limits.md): Understand API request throttling and how to handle rate limits.
- [API pricing](https://developer.peoplewisher.com/operations/pricing.md): Understand how Peoplewisher API usage is charged.
- [Service availability](https://developer.peoplewisher.com/operations/service-availability.md): Understand Peoplewisher uptime notifications and service availability.
- [Errors](https://developer.peoplewisher.com/operations/errors.md): Understand Peoplewisher API error responses.

## OpenAPI Specs

- [openapi](/openapi.yaml)