solarOS Organization API

Organization API

Get tenant-specific effective schema

Returns the calling organization effective Lead contract, including standard fields, placed Fields, writable/read-only state, requiredness, enum options, validation, relationship constraints, schema version, and generation timestamp. Required scope: schema:read.

/api/v1/schema

Returns the calling organization effective Lead contract, including standard fields, placed Fields, writable/read-only state, requiredness, enum options, validation, relationship constraints, schema version, and generation timestamp. Required scope: schema:read.

Get tenant-specific effective schema. Use an organization API key with schema:read. Check the response envelope and meta.requestId before triggering dependent workflow steps.

Required scopes

schema:read

Parameters

No path or query parameters.

Request body

This endpoint does not accept a JSON request body.

Responses

200

Effective schema envelope

object

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 schema:read scope

#/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 schema:read scope429 Rate limit exceeded

Static examples

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