Get started

Introduction

Place Developer connects your systems to Place. You send leads in, Place validates and assigns them, and every change of state is reported back to you.

Version 1 covers one product: the Lead API. You create leads and read their status. Territories, appointments and team data follow later, each behind its own scope. Pages marked Soon in the sidebar describe what is coming, not what exists.

Core concepts

Five ideas carry the whole platform. Once you know them, every endpoint behaves the way you expect.

ConceptWhat it means
ProjectsAn integration belongs to one project inside your Place workspace. Keys, webhooks and logs live in the project.
EnvironmentsEvery project has a sandbox and a production environment. Sandbox never creates real leads. Production is switched on per project.
Secret keysYou authenticate with a secret key: sk_place_test_… for sandbox, sk_place_live_… for production. Each key carries scopes.
IdempotencySending the same lead twice creates it once. Your external_id or an Idempotency-Key header makes retries safe.
EventsEach change of a lead's status becomes an event such as lead.assigned. Webhooks will deliver them to your endpoint.

Environments

The environment is part of the key, so you always know which one you are talking to. A sandbox request is validated, de-duplicated, logged and answered exactly like a production request. The difference is that it never becomes a lead a sales rep could drive to.

  • Sandbox leads keep the status received. Nothing moves them further.
  • The same external_id in sandbox and in production are two separate leads.
  • Production keys are rejected until production has been enabled for the project.

Lead lifecycle

A lead moves through a small, fixed set of public statuses. They are stable. How Place models a lead internally can change underneath without breaking you.

StatusMeaning
receivedPlace accepted the lead.
validatedThe lead is open and waiting for assignment.
assignedA rep is responsible for the lead.
contactedThe rep reached the person and agreed on a callback.
appointmentAn appointment is booked or confirmed.
wonThe sale closed.
lostThe lead will not convert.

What every response carries

Successful responses return the resource. Every response, successful or not, carries a Place-Request-Id header. The same id appears in the request log of your Console, so you and Place support can talk about exactly one request.

{
  "id": "pl_lead_8a1f3c",
  "object": "lead",
  "external_id": "lead_82716",
  "status": "received",
  "environment": "sandbox",
  "created_at": "2026-09-11T09:41:00.000Z"
}

How requests reach Place today

During the preview, all calls go to a single endpoint. The route you want goes into the JSON body, for example "route": "POST /v1/leads". Requests, responses, errors and headers are already final. When api.placee.de/v1 opens, only the address changes.

Preview

The Lead API is in preview. We keep the v1 contract stable and announce every change in the changelog.

Where to go next

  • Quickstart sends your first sandbox lead in five minutes.
  • Leads is the full reference for payload, validation and errors.
  • Webhooks explains events and how to verify signatures.