Organization API
Get one Property
Get one Property
/api/v1/properties/{id}
Get one Property
Get one Property. Use an organization API key with properties:read. Check the response envelope and meta.requestId before triggering dependent workflow steps.
Required scopes
properties:read
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| idrequired | path | string | Property identifier returned by the Organization API. |
Request body
This endpoint does not accept a JSON request body.
Responses
200
Property envelope
#/components/schemas/OrgApiResourceEnvelope
401
Missing or invalid organization API key
#/components/schemas/OrgApiError
402
Organization billing access or an endpoint-specific business quota denied the request
#/components/schemas/OrgApiError
403
Missing required scope: properties:read
#/components/schemas/OrgApiError
404
Not found
#/components/schemas/OrgApiError
429
Rate limit exceeded
#/components/schemas/OrgApiError
Errors
401 Missing or invalid organization API key402 Organization billing access or an endpoint-specific business quota denied the request403 Missing required scope: properties:read404 Not found429 Rate limit exceeded
Static examples
curl -X GET "$SOLAROS_BASE_URL/api/v1/properties/$SOLAROS_PROPERTY" \ -H "Authorization: Bearer $SOLAROS_API_KEY"