Endpoints

The Read API exposes four GET endpoints over your dictionary. All responses are wrapped in a data envelope and contain metadata only — never record data.

The field object

Several endpoints return field objects. A field has the following shape:

{
  "api_name": "Industry__c",
  "label": "Industry",
  "data_type": "picklist",
  "length": 255,
  "is_required": false,
  "is_unique": false,
  "is_external_id": false,
  "is_custom": true,
  "is_calculated": false,
  "description": "Primary industry segment.",
  "help_text": "Pick the closest match.",
  "picklist_values": ["Technology", "Finance", "Healthcare"],
  "value_set_name": "Industry_Global",
  "relationship": null,
  "last_changed_at": "2026-06-12T09:31:00Z"
}

relationship is an object for lookup and reference fields, and null otherwise.

List objects

GET /api/v1/objects

Returns every object in your dictionary.

curl https://api.schemaforce.com/v1/objects \
  -H "Authorization: Bearer sk_live_…"

Retrieve an object

GET /api/v1/objects/{apiName}

Returns a single object along with its fields array.

curl https://api.schemaforce.com/v1/objects/Account \
  -H "Authorization: Bearer sk_live_…"

An unknown object returns 404.

List fields

GET /api/v1/fields?object={apiName}

Returns the fields for one object. The object query param is required; omitting it returns 400.

curl "https://api.schemaforce.com/v1/fields?object=Account" \
  -H "Authorization: Bearer sk_live_…"

An unknown object returns 404.

List relationships

GET /api/v1/relationships?object={apiName}

Returns the relationships for one object, split into the objects it looks_up_to and the objects that reference it (referenced_by). The object query param is required; omitting it returns 400.

curl "https://api.schemaforce.com/v1/relationships?object=Contact" \
  -H "Authorization: Bearer sk_live_…"

An unknown object returns 404.

Errors