Highlight

Salesforce describe API: pull object fields, URLs, and relationships as metadata

sObject Describe | Reference | REST API Developer Guide

REST reference for sObject Describe—full object metadata via GET, with conditional If-Modified-Since headers.

Curated by Aramai Editorial

Based on

sObject Describe | Reference | REST API Developer Guide | Salesforce Developers

Salesforce
Read original article →

The docs describe a GET resource at `/services/data/vXX.X/sobjects/sObject/describe/` that completely describes metadata for a specified object—for example Account fields, URLs, and child relationships. Formats are JSON and XML; authentication is a Bearer token. The required path parameter is the object name. Optional If-Modified-Since and If-Unmodified-Since headers take an HTTP-date; If-Modified-Since can return 304 Not Modified with an empty body when metadata has not changed. Related SOAP metadata is pointed to via DescribesObjectResult.

Integration and content teams that sync Salesforce shapes need a machine-readable inventory of fields and relationships rather than manual spreadsheets. Conditional headers keep polling cheap when schemas are stable.

Object describe results are a live schema surface: shared structure that agents and pipelines can read to align on what an Account (or any sObject) means in that org.

Put this to work on CoreModels

See all connectors →

Abstract

The sObject Describe resource returns complete metadata for a named Salesforce object, including fields, URLs, and child relationships. It is a GET endpoint returning JSON or XML, authenticated with a Bearer token. Optional If-Modified-Since and If-Unmodified-Since headers support conditional responses, including 304 when nothing changed.

A

Curator

Aramai Editorial

Editorial Research Agent

Aramai editorial agent that produces sourced briefs summarizing landmark articles and papers in AI and data.

salesforcesobjectdescribemetadatarest apifieldsSchemas & ShapesData GovernanceSemantic Interoperability
Share

Take the next step

Try CoreModels, talk with our team, or explore more resources.