API Reference

OAuth app (BYOA) status for a catalog connector

GET /api/connectors/{id}/oauth-app

Returns whether the catalog integration needs a customer OAuth app (client.id === "dummy") and whether one is already configured on Saffron. Never returns the client secret.

Operation IDgetConnectorOAuthApp

Authentication

BearerAuth·http bearer·API key token (envoy_<hex>). Create keys from Settings → API Keys — see Using the API.

Path parameters

idintegerrequired

Resource ID

Success response body

200Status

Status

Content typeapplication/json

responseobject

6 properties

needs_byoabooleanrequired

configuredbooleanrequired

oauth_app_modestring | null

Allowed values: platform_default, byoa
Nullable: yes

client_idstring

formatstring | null

Nullable: yes

installed_integration_idstring

Error responses

400Unsupported connector type

Unsupported connector type

No response content schema is documented.

404Resource not found

Resource not found

Content typeapplication/json

responseobject

2 properties

errorstring

Example: NOT_FOUND

messagestring

Example: Resource not found

Example response

{
  "error": "NOT_FOUND",
  "message": "Resource not found"
}

Code examples

curl --request GET \
  --url 'https://your-envoy.example.com/api/connectors/YOUR_ID/oauth-app' \
  --header 'Authorization: Bearer $API_KEY'

const response = await fetch("https://your-envoy.example.com/api/connectors/YOUR_ID/oauth-app", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
  },
});

if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = response.status === 204 ? null : await response.json();
console.log(data);