The Silhouette API supports several query features on list resources: expand, filter, sort, page, and enum lookup.

Expand Support

Most resources support an optional expand query parameter to request more detail in the response.

Expand Keys

Simple keys:

• item — expand items of a list resource
• all — expand all possible embedded resources
• <embed name> — expand a specific embedded resource
• -<embed name> — exclude a specific embed (use with all)

Multi-level keys:

• <embed>.item — expand embedded resource, not its children
• <embed>.all — expand embedded resource including all children
• <embed>.<embed> — recursive expansion using dot notation
• -<embed>.<embed> — exclude specific nested embed

Multiple keys are separated by commas. Unrecognized or inaccessible keys are ignored. Keys are case-sensitive.

Examples

GET /api/v1/tenants/414/users?expand=item
GET /api/v1/tenants/414/users?expand=all
GET /api/v1/tenants/414/users?expand=all,-keyProfile
GET /api/v1/tenants/414/users?expand=featureSettings,adminSettings
GET /api/v1/tenants/414/users/100?expand=all
GET /api/v1/tenants/414/users/100?expand=callPermissionProfile

Filter Support