solarOS Organization API

Organization API

List Quotes

Lists Quotes inside the organization boundary with endpoint-declared filters, safe relations, customFields, and External References. Supply externalSystem, externalObject, and externalId together to filter by a canonical External Reference. Required scope: quotes:read.

/api/v1/quotes

Lists Quotes inside the organization boundary with endpoint-declared filters, safe relations, customFields, and External References. Supply externalSystem, externalObject, and externalId together to filter by a canonical External Reference. Required scope: quotes:read.

List Quotes. Use an organization API key with quotes:read. Check the response envelope and meta.requestId before triggering dependent workflow steps.

Required scopes

quotes:read

Parameters

NameInTypeDescription
limitqueryintegerMaximum records to return. Defaults to 50 and is capped at 100.
cursorquerystringOpaque record cursor from the previous response meta.nextCursor value.
sortDirqueryasc | descSort direction. Defaults to desc.
statusqueryDRAFT | PENDING_APPROVAL | SENT | VIEWED | ACCEPTED | REJECTED | EXPIRED | CANCELLEDFilter by exact Quote status.
customerIdquerystringFilter by Customer id.
propertyIdquerystringFilter by Property id.
opportunityIdquerystringFilter by Opportunity id.
ownerIdquerystringFilter by owner Team Member id.
quoteTypeIdquerystringFilter by Company Quote Type id.
externalSystemquerystringExternal Reference system filter. Supply with externalObject and externalId for exact reconciliation lookup.
externalObjectquerystringExternal Reference object filter. Supply with externalSystem and externalId.
externalIdquerystringExternal Reference id filter. Supply with externalSystem and externalObject.

Request body

This endpoint does not accept a JSON request body.

Responses

200

Quote list envelope

#/components/schemas/OrgApiListEnvelope

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: quotes:read

#/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: quotes:read429 Rate limit exceeded

Static examples

curl -X GET "$SOLAROS_BASE_URL/api/v1/quotes" \
  -H "Authorization: Bearer $SOLAROS_API_KEY"