Skip to documentation
Weavers Docs

Pages and endpoints

Tab to navigate · Enter to openEsc to close

GET /api/articles/:id/comments

Public access · HTTP API reference

All endpoints · Authentication and retries · Download OpenAPI

Request

ParameterLocationType and requirement
idpathstring · required
limitquerystring · optional

No request body.

Example

Examples use fictional data. Replace identifiers with resources you can access. For account requests, cookies.txt must contain your own session; set CSRF_TOKEN to the matching CSRF cookie value where required.

cURL (POSIX shell)
curl --include \
  --request GET \
  'https://api.weavers.app/api/articles/1/comments'

Responses

200 · Successful response.

application/json

200 example · synthetic data
[]
View response model

Array items:

id required · number
articleId required · string
userId required · number
displayName required · string
avatarUrl optional · null | string
View avatarUrl model
Variant 1: null

null

Variant 2: string

string

text required · string
createdAt required · string
updatedAt required · null | string
View updatedAt model
Variant 1: null

null

Variant 2: string

string

deletedAt required · null | string
View deletedAt model
Variant 1: null

null

Variant 2: string

string

parentId required · null | number
View parentId model
Variant 1: null

null

Variant 2: number

number

isOwner required · boolean
isDeleted required · boolean

Additional fields: JSON values.

400 · Invalid request.

application/json

400 example · synthetic data
{
  "error": "example"
}
View response model
error required · string

Additional fields: JSON values.

404 · Resource or enabled capability not found.

application/json

404 example · synthetic data
{
  "error": "example"
}
View response model
error required · string

Additional fields: JSON values.

429 · Rate limit reached; honor Retry-After when supplied.

application/json

429 example · synthetic data
{}
View response model

Error envelopes can include resource-specific details. Check the status before reading these fields.

error optional · string
code optional · string
message optional · string

Additional fields: JSON values.

500 · Server failure.

application/json

500 example · synthetic data
{
  "error": "example"
}
View response model
Variant 1: object
error required · string

Additional fields: JSON values.