Get an OAuth app
⚠️
Preview — this feature is being built; the design below is the spec.
GET https://app.syntic.ai/v1/organizations/oauth_apps/{client_id}Return one app with its sign-in counts.
For how this fits into a full workflow, see Build a Sign in with Syntic app.
Headers
| Header | Required | Value |
|---|---|---|
Authorization | Yes | Bearer <admin key>: an Admin API key (sk_admin_...). Inference keys are refused with 403 admin_key_required. See Admin API keys. |
syntic-beta | Yes, while in preview | oauth-apps-2026-12-01. Without it the call fails with 400 beta_required. See Versioning. |
Path parameters
| Parameter | Type | Description |
|---|---|---|
client_id | string | The app’s client id, starting with oapp_. |
Response
200 OK, Content-Type: application/json
{
"id": "oapp_01JD79H1K3M5P7R9T1V3",
"type": "oauth_app",
"client_id": "oapp_01JD79H1K3M5P7R9T1V3",
"name": "Acme Notes",
"client_type": "public",
"redirect_uris": [
"https://notes.example.com/oauth/callback"
],
"allowed_scopes": [
"user:profile",
"user:inference"
],
"audience": "organization",
"logo_url": "https://notes.example.com/logo.png",
"status": "active",
"created_at": "2026-11-05T10:00:00Z",
"active_grants": 214
}| Field | Type | Description |
|---|---|---|
client_type | string | public (no secret; PKCE required) for desktop, mobile and browser apps, or confidential (has a secret; PKCE still required) for server-side apps. |
redirect_uris | array | Exact HTTPS addresses. Loopback http://127.0.0.1 with any port is allowed for public desktop clients. |
allowed_scopes | array | The most the app can ask for. user:inference lets it call /v1 billed to the signing-in person’s organization. |
audience | string | organization: only your members can sign in. any: any Syntic user can, after Syntic reviews the app. |
active_grants | integer | People with a live refresh token for the app. |
Examples
curl -sS "https://app.syntic.ai/v1/organizations/oauth_apps/oapp_01JD79H1K3M5P7R9T1V3" \
-H "Authorization: Bearer $SYNTIC_ADMIN_KEY" \
-H "syntic-beta: oauth-apps-2026-12-01"Errors
Errors use the error envelope and carry a request_id. Codes specific to this operation:
| Status | type | code | When |
|---|---|---|---|
| 400 | invalid_request_error | beta_required | The syntic-beta header is missing. |
| 404 | not_found_error | oauth_app_not_found | No app with this client id in the organization. |
| 401 | authentication_error | invalid_api_key | The admin key is missing, unknown, revoked or expired. |
| 403 | permission_error | admin_key_required | An inference key was used. |
| 429 | rate_limit_error | rate_limited | Too many requests; wait for Retry-After. See Rate-limit headers. |
Was this page helpful?