List Properties
Lists Properties linked to the calling organization. Supply externalSystem, externalObject, and externalId together to filter by a canonical External Reference. Required scope: properties:read.
Lists Properties linked to the calling organization. Supply externalSystem, externalObject, and externalId together to filter by a canonical External Reference. Required scope: properties:read.
List Properties. Use an organization API key with properties:read. Check the response envelope and meta.requestId before triggering dependent workflow steps.
Required scopes
Parameters
| Name | In | Type | Description |
|---|---|---|---|
| limit | query | integer | Maximum records to return. Defaults to 50 and is capped at 100. |
| cursor | query | string | Opaque record cursor from the previous response meta.nextCursor value. |
| sortDir | query | asc | desc | Sort direction. Defaults to desc. |
| customerId | query | string | Filter by Customer id. |
| externalSystem | query | string | External Reference system filter. Supply with externalObject and externalId for exact reconciliation lookup. |
| externalObject | query | string | External Reference object filter. Supply with externalSystem and externalId. |
| externalId | query | string | External Reference id filter. Supply with externalSystem and externalObject. |
Request body
This endpoint does not accept a JSON request body.
Responses
Property list envelope
#/components/schemas/OrgApiListEnvelope
Missing or invalid organization API key
#/components/schemas/OrgApiError
Organization billing access or an endpoint-specific business quota denied the request
#/components/schemas/OrgApiError
Missing required scope: properties:read
#/components/schemas/OrgApiError
Rate limit exceeded
#/components/schemas/OrgApiError
Errors
Static examples
curl -X GET "$SOLAROS_BASE_URL/api/v1/properties" \ -H "Authorization: Bearer $SOLAROS_API_KEY"