643 matches
40 actions
Forem API V1
40 actions
Social/Forem API V1
This endpoint allows the client to retrieve a list of articles.
"Articles" are all the posts that users create on DEV that typically show up in the feed. They can be a blog post, a discussion question, a help thread etc. but is referred to as article within the code.
By default it will return featured, published articles ordered by descending popularity.
It supports pagination, each page will contain 30 articles by default.
{
"type": "object",
"properties": {
"collection_id": {
"type": "integer",
"format": "int32"
},
"page": {
"type": "integer",
"format": "int32"
},
"per_page": {
"type": "integer",
"format": "int32"
},
"state": {
"type": "string",
"enum": [
"fresh",
"rising",
"all"
]
},
"tag": {
"type": "string"
},
"tags": {
"type": "string"
},
"tags_exclude": {
"type": "string"
},
"top": {
"type": "integer",
"format": "int32"
},
"username": {
"type": "string"
}
},
"additionalProperties": false
}{
"type": "array",
"items": {
"type": "object",
"description": "Representation of an article or post returned in a list",
"required": [
"type_of",
"id",
"title",
"description",
"cover_image",
"readable_publish_date",
"social_image",
"tag_list",
"tags",
"slug",
"path",
"url",
"canonical_url",
"comments_count",
"positive_reactions_count",
"public_reactions_count",
"created_at",
"edited_at",
"crossposted_at",
"published_at",
"last_comment_at",
"published_timestamp",
"user",
"reading_time_minutes"
],
"properties": {
"canonical_url": {
"type": "string",
"format": "url"
},
"cover_image": {
"type": "string",
"format": "url"
},
"created_at": {
"type": "string",
"format": "date-time"
},
"crossposted_at": {
"type": "string",
"format": "date-time"
},
"description": {
"type": "string"
},
"edited_at": {
"type": "string",
"format": "date-time"
},
"flare_tag": {
"type": "object",
"description": "Flare tag of the article",
"properties": {
"bg_color_hex": {
"type": "string",
"description": "Background color (hexadecimal)"
},
"name": {
"type": "string"
},
"text_color_hex": {
"type": "string",
"description": "Text color (hexadecimal)"
}
}
},
"id": {
"type": "integer",
"format": "int32"
},
"last_comment_at": {
"type": "string",
"format": "date-time"
},
"organization": {
"type": "object",
"description": "The organization the resource belongs to",
"properties": {
"name": {
"type": "string"
},
"profile_image": {
"type": "string",
"format": "url",
"description": "Profile image (640x640)"
},
"profile_image_90": {
"type": "string",
"format": "url",
"description": "Profile image (90x90)"
},
"slug": {
"type": "string"
},
"username": {
"type": "string"
}
}
},
"path": {
"type": "string",
"format": "path"
},
"positive_reactions_count": {
"type": "integer",
"format": "int32"
},
"public_reactions_count": {
"type": "integer",
"format": "int32"
},
"published_at": {
"type": "string",
"format": "date-time"
},
"published_timestamp": {
"type": "string",
"format": "date-time",
"description": "Crossposting or published date time"
},
"readable_publish_date": {
"type": "string"
},
"reading_time_minutes": {
"type": "integer",
"format": "int32",
"description": "Reading time, in minutes"
},
"slug": {
"type": "string"
},
"social_image": {
"type": "string",
"format": "url"
},
"tag_list": {
"type": "array",
"items": {
"type": "string"
}
},
"tags": {
"type": "string"
},
"title": {
"type": "string"
},
"type_of": {
"type": "string"
},
"url": {
"type": "string",
"format": "url"
},
"user": {
"type": "object",
"description": "The resource creator",
"properties": {
"github_username": {
"type": "string"
},
"name": {
"type": "string"
},
"profile_image": {
"type": "string",
"description": "Profile image (640x640)"
},
"profile_image_90": {
"type": "string",
"description": "Profile image (90x90)"
},
"twitter_username": {
"type": "string"
},
"username": {
"type": "string"
},
"website_url": {
"type": "string",
"format": "url"
}
}
}
}
}
}