Organization API
List quote-generated Contracts
List quote-generated Contracts
/api/v1/contracts
List quote-generated Contracts
List quote-generated Contracts. Use an organization API key with contracts:read. Check the response envelope and meta.requestId before triggering dependent workflow steps.
Required scopes
contracts:read
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. |
| status | query | DRAFT | PENDING_SIGNATURE | PARTIALLY_SIGNED | COMPLETED | VOIDED | EXPIRED | Filter by exact Contract status. |
| quoteId | query | string | Filter by source Quote id. |
| customerId | query | string | Filter by Customer id. |
Request body
This endpoint does not accept a JSON request body.
Responses
200
Contract 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: contracts: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: contracts:read429 Rate limit exceeded
Static examples
curl -X GET "$SOLAROS_BASE_URL/api/v1/contracts" \ -H "Authorization: Bearer $SOLAROS_API_KEY"