REST API Developer Guide

Introducing Lightning Platform REST API
Quick Start
Examples
Reference
Versions
Resources by Version
Limits
Describe Global
SObject Basic Information
SObject Describe
SObject Get Deleted
SObject Get Updated
SObject Named Layouts
SObject Rows
SObject Rows by External ID
SObject Blob Retrieve
SObject ApprovalLayouts
SObject CompactLayouts
Describe Layouts
SObject PlatformAction
SObject Quick Actions
SObject Rich Text Image Retrieve
SObject Relationships
SObject Suggested Articles
SObject User Password
Platform Event Schema by Event Name
Platform Event Schema by Schema ID
AppMenu
Compact Layouts
Consent
Embedded Service Configuration Describe
Invocable Actions
List View Describe
List View Results
List Views
Support Knowledge with REST API
Parameterized Search
Process Approvals
Process Rules
Product Schedules
Query
QueryAll
Quick Actions
Recent List Views
Recently Viewed Items
Record Count
Relevant Items
Retrieve Knowledge Language Settings
Search
Search Scope and Order
Search Result Layouts
Lightning Toggle Metrics
Lightning Usage by App Type
Lightning Usage by Browser
Lightning Usage by Page
Lightning Usage by FlexiPage
Lightning Exit by Page Metrics
Lightning Scheduler Resources
Search for Records Suggested by Autocomplete and Instant Results
Search Suggested Article Title Matches
Search Suggested Queries
Tabs
Themes
Composite Resources
Headers
Status Codes and Error Responses
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Embedded Service Configuration Describe

Retrieves the values for your Snap-in deployment configuration, including the branding colors, font, and site URL.

Syntax

URI
/services/data/vXX.X/support/embeddedservice/configuration/EmbeddedServiceConfigDeveloperName
Available since release
45.0
Formats
JSON
HTTP methods
GET, HEAD
Authentication
You must be logged in to the account that owns the EmbeddedServiceConfigDeveloperName you are querying.
Request parameters
None

Example

Retrieving the values for the Snap-in deployment TestOne

JSON Response body

This sample JSON response is for a Live Agent Snap-in deployment. The JSON response for another Snap-in feature, such as an embedded flow, will have different values.