Get started

Authentication

Every request is authenticated with a secret key in the Authorization header.

Authorization: Bearer sk_place_test_4f8Q…

Keys

PrefixEnvironmentUse
sk_place_test_SandboxServer-side. Never creates real leads.
sk_place_live_ProductionServer-side. Creates real leads. Only after Place enables production for the project.
pk_place_…—Reserved for future client-side use. No v1 endpoint accepts it.

Rules

  • Send the key only in the Authorization header. Keys in query strings end up in access logs and are not accepted.
  • Use secret keys only from your server — never in a browser, a mobile app or a repository.
  • A key is shown once, when you create it. Place stores a SHA-256 hash and the last four characters, nothing more.
  • Each key belongs to one project and one environment. A sandbox key cannot reach production data.

Rotation and revocation

Rotate creates a new key immediately; the old key keeps working for 24 hours so you can deploy the new one without downtime. Revoke stops a key immediately. Archiving a project revokes all of its keys. All three live in the Console.

When authentication fails

StatuscodeMeaning
401invalid_api_keyMissing, malformed, revoked or expired key.
401secret_key_requiredA publishable key was sent where a secret key is needed.
403project_unavailableThe key's project was archived.
403production_not_enabledA live key for a project without production access.
403missing_scopeThe key is valid but may not do this. See Scopes.

How each endpoint checks keys and scopes: Leads reference.

Leaked a key?

Revoke it in the Console right away, then create a new one. Revocation takes effect with the next request.