Quick start

Make your first authenticated API call in under five minutes.

1. Create a partner account

Register at the partner portal or contact us for enterprise onboarding. You'll receive a **sandbox API key** immediately — no support ticket required.

2. Set your API key

Pass the key in the Authorization header on every request.

export PADDIE_API_KEY="pk_sandbox_xxxxxxxx"

3. Check API health

Verify connectivity before integrating property data.

curl -s https://api.paddie.channel/v1/health \
  -H "Authorization: Bearer $PADDIE_API_KEY"

4. List properties

Fetch properties linked to your organization.

curl -s https://api.paddie.channel/v1/properties \
  -H "Authorization: Bearer $PADDIE_API_KEY" \
  -H "Accept: application/json"

5. Go live

Complete sandbox certification in the partner portal, then swap `pk_sandbox_*` for `pk_live_*`. Production keys inherit the same API surface.

← Introduction Authentication →