> ## Documentation Index
> Fetch the complete documentation index at: https://developer.peoplewisher.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Make your first Peoplewisher API request and add a contact to a celebration workflow.

The quickest integration is to create a Celebration Group, add a contact to it, and let Peoplewisher handle the configured workflow.

## 1. Get your API key

In PeopleWisher:

**Settings → API**

Copy the API key for the account you want your application to use.

Keep the key on your server. Do not expose it in browser JavaScript, mobile applications, or public repositories.

## 2. Set your base URL

```text theme={null}
https://api.peoplewisher.com/v1
```

All API requests use HTTPS.

## 3. Authenticate

Send the API key as a Bearer token:

```bash theme={null}
curl https://api.peoplewisher.com/v1/celebration-groups \
  -H "Authorization: Bearer $PEOPLEWISHER_API_KEY"
```

## 4. Find the right Celebration Group

The group list includes the category associated with each group:

```json theme={null}
{
  "success": true,
  "data": [
    {
      "group_id": 24,
      "name": "Customers",
      "category": "birthday",
      "status": "active",
      "contact_count": 174
    }
  ]
}
```

Store the `group_id` you want to use.

## 5. Add a contact

```bash theme={null}
curl -X POST https://api.peoplewisher.com/v1/contacts \
  -H "Authorization: Bearer $PEOPLEWISHER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "first_name": "Ada",
    "last_name": "Okafor",
    "email": "ada@example.com",
    "phone": "+2348012345678",
    "whatsapp_phone": "+2348012345678",
    "birthday": "1994-10-12",
    "timezone": "Africa/Lagos",
    "group_id": 24
  }'
```

A successful response returns the Peoplewisher contact.

## 6. Let Peoplewisher do the rest

There is no follow-up API call to schedule the birthday.

The group determines what Peoplewisher does next. The account owner manages the group's templates, channels, timing, and celebration settings from the Peoplewisher UI.

## Typical synchronization flow

```text theme={null}
Your application
      │
      ├── Get Peoplewisher group IDs
      │
      ├── Create/update contacts
      │
      └── Assign contacts to groups
                 │
                 ▼
          PeopleWisher
                 │
                 ├── Group settings
                 ├── Templates
                 ├── Timing
                 └── Email / SMS / WhatsApp
```

## Next steps

* Read [Authentication](/authentication).
* Understand the [platform model](/platform-model).
* Review [Contacts](/guides/contacts).
* Review [Celebration Groups](/guides/celebration-groups).