Skip to main content
GET
Get Property

Authorizations

Authorization
string
header
required

Generate a shared token via /authenticate/token, then pass it as Authorization: Bearer <token>.

Path Parameters

property_id
string
required

Unique property identifier.

Query Parameters

workspace_id
string
required

Public workspace UUID. This is not the workspace MongoDB _id.

Response

Property retrieved successfully.

status
string
required
Allowed value: "success"
message
string
required
Example:

"Property retrieved successfully"

data
object
required