User-related API environment

Production user-related API docs

These pages describe the Production user-related API stack.

Use production OAuth credentials, production API base URLs, and production app URLs when following this documentation.

Need to test before going live? Switch to the Pre-live docs using the environment switcher above.

List connected apps for the authenticated user

Groups every linked OAuth client under its logical app and returns metadata only. Raw OAuth client and App State namespace identifiers are never returned.

Responses

• 200
• 401
• 500
• 503

---

The authenticated user’s connected logical apps.

application/json

Schema

Example (from schema)

Example

---

Schema

success boolean required

Possible values: [true]

data object required
apps object[] required
Array [
appId uuid required
name string required
environment string required
Possible values: [prelive, production]
logoUrl uri nullable
appUrl uri nullable
storage object required
status string required
Possible values: [active, disabled, suspended, archived, not_configured]
categories string[] required
grant object required
status string required
Possible values: [active]
scopes string[] required
effectiveScopes string[] required
connectedAt date-time nullable required
The latest time an OAuth consent for this logical app was handled.
lastAccessedAt date-time nullable deprecated
Reserved for actual app-access telemetry and currently null. Use connectedAt for consent time.
]

{
  "success": true,
  "data": {
    "apps": [
      {
        "appId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "string",
        "environment": "prelive",
        "logoUrl": "string",
        "appUrl": "string",
        "storage": {
          "status": "active",
          "categories": [
            "string"
          ]
        },
        "grant": {
          "status": "active",
          "scopes": [
            "string"
          ],
          "effectiveScopes": [
            "string"
          ]
        },
        "connectedAt": "2026-10-12T08:05:32.116Z"
      }
    ]
  }
}

{
  "success": true,
  "data": {
    "apps": [
      {
        "appId": "123e4567-e89b-12d3-a456-426614174000",
        "name": "string",
        "environment": "prelive",
        "logoUrl": "string",
        "appUrl": "string",
        "storage": {
          "status": "active",
          "categories": [
            "string"
          ]
        },
        "grant": {
          "status": "active",
          "scopes": [
            "string"
          ],
          "effectiveScopes": [
            "string"
          ]
        },
        "connectedAt": "2026-04-02T00:00:00.000Z",
        "lastAccessedAt": "2026-04-02T00:00:00.000Z"
      }
    ]
  }
}

A valid Quran.com user session is required.

The Connected Apps operation was rejected or could not be completed.

application/json

Schema

Example (from schema)

Example

---

Schema

success boolean required

Possible values: [false]

error object required
code string required
message string required
details object
property name* any

{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

The Connected Apps operation was rejected or could not be completed.

application/json

Schema

Example (from schema)

Example

---

Schema

success boolean required

Possible values: [false]

error object required
code string required
message string required
details object
property name* any

{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

{
  "success": false,
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  }
}

Loading...