# Szybki start

> REST API propertly.io (Headless CMS): pobieraj oferty, agentów, oddziały i inwestycje biura na własną stronę lub aplikację i przesyłaj formularze kontaktowe jako leady.

Źródło: https://propertly.io/dokumentacja/api
Ostatnia aktualizacja: 2026-10-15

Przez REST API pobierzesz dane swojego biura z propertly.io i wyświetlisz je na własnej stronie lub w aplikacji, w dowolnej technologii. Formularze kontaktowe ze strony możesz przez API przesyłać do propertly.io jako leady.

## Adres API

```
https://headless-cms.propertly.io/api/v1
```

Odpowiedzi są w formacie JSON. Endpointy z ofertami zwracają też XML – wybierasz go nagłówkiem `Accept`.

## Uwierzytelnianie

Każde zapytanie musi zawierać klucz API w nagłówku `Authorization`. Klucz znajdziesz w panelu CRM. Klucz jest przypisany do strony www, więc API zwraca tylko dane organizacji, do której ta strona należy.

```bash
curl https://headless-cms.propertly.io/api/v1/organization \
  -H "Authorization: <klucz API>"
```

Zapytanie bez klucza kończy się odpowiedzią `401`.

> **Nie umieszczaj klucza w kodzie przeglądarki**
>
> Klucz API daje dostęp do danych Twojego biura i pozwala wysyłać formularze w jego imieniu. Używaj go po stronie serwera (np. w Next.js w Server Components lub w API route), a nie w JavaScripcie wysyłanym do przeglądarki.

## Endpointy

- [Organizacja](https://propertly.io/dokumentacja/api/organizacja/get-organization) – dane biura.
- [Oddziały](https://propertly.io/dokumentacja/api/oddzialy/get-all-branches) – lista oddziałów i szczegóły oddziału.
- [Agenci](https://propertly.io/dokumentacja/api/agenci/get-all-agents) – wszyscy agenci, agenci oddziału i szczegóły agenta.
- [Inwestycje](https://propertly.io/dokumentacja/api/inwestycje/get-all-investments) – lista inwestycji i szczegóły inwestycji.
- [Oferty](https://propertly.io/dokumentacja/api/oferty/get-offers) – aktywne oferty biura, oddziału, agenta lub inwestycji, z paginacją, filtrami i sortowaniem, oraz szczegóły pojedynczej oferty.
- [Formularze](https://propertly.io/dokumentacja/api/formularze/post-form) – przesłanie formularza kontaktowego jako leada.
- [Tłumaczenia](https://propertly.io/dokumentacja/api/tlumaczenia/get-translations) – etykiety pól i wartości słownikowych w wybranym języku.

Na stronie każdego endpointu wyślesz testowe zapytanie ze swoim kluczem API. Pełna specyfikacja OpenAPI jest dostępna pod adresem [propertly.io/openapi.json](https://propertly.io/openapi.json).