Listings

Three listing types (kind): property - for sale, rental - for rent, complex - residential complex. Reading is free and open to any key; creating, editing and deleting need the objects:write scope and are not charged either.

List

curl "https://developers.grem.capital/api/v1/objects?kind=property&city=Berlin&limit=20" \
  -H "Authorization: Bearer gsk_live_xxx"

GET /objects:

Response: data - the listings, paginate - currentPage, totalPages, totalCount.

limit and page outside the range are cut into it, not refused. Other invalid values of a known parameter (an unknown enum value, a non-integer page, text instead of a number) are refused with 400 validation naming the field.

One listing

GET /objects/{kind}/{id} - one listing in the same shape. Unknown id - 404. An agency key can add scope=catalog to get the public view.

Listing shape

Categories and other attributes are codes; translated labels are in the dictionaries. Complex also has apartmentPlans (floor plans) and progress (construction progress).

What you see: any listing - the public card, as on the site; your listings - the full owner view. Nobody gets the owner's contacts, seller data from imports, moderation notes or originals without the watermark.

Create, edit, delete

curl -X POST https://developers.grem.capital/api/v1/objects/property \
  -H "Authorization: Bearer gsk_live_xxx" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 9a1d2c3b-4e5f-4a6b-8c7d-0e1f2a3b4c5d" \
  -d '{
    "name": "2-room flat, Torstraße 12",
    "type": "Residential",
    "address": { "country": "Germany", "city": "Berlin", "street": "Torstraße", "streetNumber": "12" },
    "price": 320000, "currency": "EUR",
    "spaceAll": 64, "rooms": 2, "floor": 3, "buildingFloor": 5,
    "photos": ["https://example.com/1.jpg"],
    "publish": false
  }'

• publish: false (default) - a draft, not in the catalog; publish: true - published. Publishing needs at least 1 photo for property and rental, 2 for complex.
• Not every account role may create every kind - same as in the cabinet.
• Unknown fields are ignored. Take category codes from the dictionaries. The codes of condition, conditionType and amenities (camelCase, like needsRenovation, fridge) are listed in the write schema itself (the tables below and /openapi.json) - GET /dictionaries does not decode them.
• Areas: a number in m² or { "value": 700, "unit": "ft2" }.
• PUT without photos keeps the existing photos.
• Idempotency-Key on create prevents a duplicate on retry.

Photos

photos is an array; each item is:

• a public https://... address - GREM downloads the image itself;
• the id of a file uploaded with POST /uploads (Files).

An address that cannot be downloaded is skipped and reported in the response warnings. With strictPhotos: true such a request fails with 422 instead.

Property fields

Required: name, type, address, price.

Rental fields

Required: name, type (Residential, Commercial, Industrial), address, price. Most fields are as for property; rental-specific ones:

Complex fields

Required: name, address.

The full schema of each kind with every value - components ObjectWriteProperty, ObjectWriteRental, ObjectWriteComplex in /openapi.json. They are generated from the same checks the server runs.

Agency key

With a personal key both answer 403. A listing cannot move directly from one agency to another (409 conflict) - move it to personal first. Assigning an agent to a personal listing, or to someone who is not an active member of the agency, is 409 conflict too. Permissions: into the agency - the listing's author; back to personal - a manager, the agency owner or the author; assign anyone - manager and above, an agent - only themselves.

Events

object.created, object.updated, object.published, object.deleted - see Webhooks.

Related

• Dictionaries - category and attribute codes.
• Files - uploading photos.
• Listing materials - landing page and PDF for a listing.