noun phraseDeveloper APIspreferred in this glossary

Named relationship requested through expand[] or a comma separated expand value that asks the Intelligence API to include related data in one response. Each available path has its own tier and scope requirements; an unknown or forbidden path produces an error. The syntax follows the pattern Stripe's API uses.

Source: Stripe, Expansion (opens in a new tab)

In plain language

Ask for a related object alongside the main result when your key can access it.

In a sentence

  • The expand path added the role taxonomy to the salary response.
  • We removed a forbidden expand path after the API returned a permission error.

Examples written for this glossary

Usage note

A wildcard requests the accessible paths for that endpoint. An explicit forbidden path rejects the whole request rather than returning a partial expansion.

See also

  • Field shaping

    Field shaping is the ?fields= query parameter, which keeps only the named parts of an Orbyt Intelligence response: a comma-separated list of paths such as role.title, estimate.median or cities[].slug, where * keeps everything.

  • Scope

    A scope is a permission on an API key that decides which endpoints the key may call, such as intelligence:read, compensation:read, skills:read, market:read or intelligence:lineage.

Cite this term.

CC BY 4.0, attribution required.

This term

Orbyt Labs, Expand path (Developer Glossary), Nov 6, 2026. https://www.orbytlabs.ai/developers/glossary/expand-path

The dataset (JSON)

Orbyt Labs Glossaries (Nov 14, 2026), https://www.orbytlabs.ai/glossary#dataset

Last updated .