Appearance
Get first-party Desktop OAuth configuration ​
This Desktop operation is available through GET /oauth/desktop-config. Use the reference below to inspect its request contract and documented responses before connecting it to your application.
Request preparation ​
Send a GET request to /oauth/desktop-config on the appropriate server. Check the API overview for base URL guidance and the server information in the interactive reference. Replace path placeholders with identifiers from the intended account or site; a similarly named record in another workspace is not interchangeable.
No separate path or query parameters are declared for this operation in the current specification. Do not invent filtering or pagination options from another endpoint; use only the contract shown here.
No request body is declared in the current specification. Check the route and any documented parameters before sending the request rather than adding an arbitrary JSON payload.
Authentication and scope ​
This operation does not declare an OpenAPI security requirement. Check the description and parameter definitions for any signed URL, customer identity, webhook, or browser-session conditions before using it outside a test environment.
Keep credentials in the appropriate private configuration and remove secrets from shared logs. Confirm the target resource belongs to the intended workflow before issuing a request. Authentication alone should not be treated as confirmation that a supplied account, site, or customer identifier is correct.
Response handling ​
The documented responses for Get first-party Desktop OAuth configuration are:
- 200: OK
Begin with a known record or a narrow query and inspect the returned fields before displaying them to users. Where the operation defines pagination, follow those parameters to retrieve additional results. An empty successful response is different from a failed request; keep errors visible to the calling workflow instead of presenting them as an empty data set.
If a connection fails after submission, investigate the current server state before repeating an action whose outcome is uncertain. When requesting support, retain the method, route, response status, and sanitized error message. The interactive reference below provides the detailed schemas and examples for this specific operation.
Get first-party Desktop OAuth configuration​
GET
/oauth/desktop-config
Responses​
OK
application/json
JSON"oauth": "string"
{
 Â
}