| id |
comments-controller-success |
| title |
CommentsController_success |
| description |
CommentsController_success |
| sidebar_label |
CommentsController_success |
| hide_title |
true |
| hide_table_of_contents |
true |
| api |
| operationId |
parameters |
responses |
tags |
servers |
description |
method |
path |
security |
securitySchemes |
info |
postman |
CommentsController_success |
| name |
required |
in |
schema |
id |
true |
path |
|
|
|
|
|
| url |
description |
|
Pre-production Server |
|
| url |
description |
|
Production Server |
|
|
CommentsController_success |
get |
/v1/comments/{id}/delete |
|
| x-auth-token |
x-client-id |
| type |
in |
name |
description |
apiKey |
header |
x-auth-token |
The JWT access token required for accessing the endpoints. |
|
| type |
in |
name |
description |
apiKey |
header |
x-client-id |
Your client id |
|
|
| title |
version |
description |
User-related APIs |
1.0.0 |
Quran.Foundation user-related APIs enable your app to seamlessly integrate with Quran.Foundation's user-centric features, providing access to personalized notes, bookmarks, goals, streaks, reading sessions, and more. This differentiates them from [content APIs](/docs/category/content-apis) that focus on non-user-specific resources like translations, tafsirs, and verses.
## How to get access
We are using OAuth2 flows to authenticate and authorize requests. To get started, you need to [get an access token](/docs/tutorials/oidc/getting-started-with-oauth2#obtaining-oauth-20-client-credentials) to make requests to our APIs. Then follow the steps mentioned [here](/docs/tutorials/oidc/getting-started-with-oauth2).
## Pagination
We are using cursor based pagination. The pagination query params consist of `first`,`after`, `before` and `last`.
Example
- `first: 10` will give you first 10 items
- `first: 10, after: xyz` will give you first 10 items after the item with id `xyz`
- `last: 10` will give you the last 10 items
- `last: 10, before: xyz` will give you the last 10 items before the item with id `xyz`
The only possible combinations are `first + after` or `last + before`. They should not be used together |
|
| name |
description |
url |
method |
Comments Controller success |
|
| path |
host |
query |
variable |
|
|
|
| disabled |
description |
type |
value |
key |
false |
| content |
type |
(Required) |
text/plain |
|
any |
|
id |
|
|
|
GET |
|
|
| sidebar_class_name |
get api-method |
| info_path |
docs/user_related_apis_versioned/1.0.0/user-related-apis |
| custom_edit_url |
|
import ApiTabs from "@theme/ApiTabs";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import TabItem from "@theme/TabItem";
CommentsController_success
CommentsController_success
Path Parameters