Retrieve publication status

Check requested visibility, processing state and marked images.

GET/v1/properties/{property_id}/publication

On this page

Example request
Authorization
Path parameters
Response
Errors

status is private, pending, processing, published, ready or failed. requested is desired catalogue visibility; published is effective visibility. ready means public copies are available for an export without publishing the property. New photos are watermarked; migration-grandfathered photos retain their unmarked copies.

While pending or processing, poll every two seconds. When failed, inspect the safe error code, fix the cause and repeat the publication request. Automatic retries are bounded; do not busy-loop failed requests.

Example request

curl "https://api.vestta.app/v1/properties/1/publication" \
  -H "X-Api-Key: $VESTTA_API_KEY"

Authorization

X-Api-Keystringheaderrequired
Your API key, AC_LIVE_<key_id>.<secret>. Authorization: ApiKey <key> is also accepted.

Path parameters

property_idintegerrequired≥ 1

Response

200 Successful response.

Example response

{
  "status": "ok",
  "data": {
    "status": "private",
    "published": false,
    "requested": false,
    "images": []
  }
}

Response fields

statusstring default: ok always ok
dataPublicationStaterequired
- statusstringrequired
  One ofprivatependingprocessingpublishedreadyfailed
- publishedbooleanrequired
- requestedbooleanrequired
- imagesarray of objects
  idstringrequired
  urlstringrequired
  Permanent opaque public-copy URL. New photos are watermarked; migrated legacy copies may remain unmarked. Never an original or upload URL.
  orderinteger default: 1
  is_primaryboolean default: false
  titlestring default:
- errorstring
  Safe diagnostic code. Retry the same publication request after correcting the cause.

Errors

Status	When
401 Unauthorized	The API key is missing, malformed, unknown, revoked or expired.
403 Forbidden	The API key lacks the required scope.
404 Not Found	The resource does not exist in this business.
409 Conflict	Duplicate contact or idempotency key reused with a different payload.
422 Unprocessable Content	A path parameter, query parameter or body field is invalid.
500 Internal Server Error	Unexpected server error while processing the request.

Error bodies and how to handle each case: Errors.