Skip to main content
GET
/
posts
List all posts
curl --request GET \
  --url http://localhost:3001/portal-api/posts \
  --header 'Authorization: <api-key>'
[
  {
    "ID": 1,
    "Content": "# Title\r\n## Subtitle\r\nContent goes here",
    "MarkdownEnabled": true,
    "Status": "published",
    "Title": "Get started this API Product",
    "Lede": "<string>",
    "Type": "<string>",
    "Path": "<string>",
    "Categories": [
      "<string>"
    ],
    "Tags": [
      "<string>"
    ],
    "CreatedAt": "2023-06-25 13:37",
    "UpdatedAt": "2023-06-25 13:37"
  }
]

Authorizations

​
Authorization
string
header
required

Query Parameters

​
limit
integer

Maximum number of records to return for this request. Overrides the row count only, not the page offset (which is always based on per_page), so use per_page for pagination rather than combining limit with page. Defaults to the per_page value.

​
per_page
integer
default:20

Items per page. Defaults to the resource-specific page count if configured, otherwise 20

​
page
integer
default:1

Page number. Defaults to 1 when omitted

Response

200 - application/json

OK

​
ID
integer

Unique identifier for the post

Example:

1

​
Content
string

Content of this tutorial page. If MarkdownEnabled is true then content of this tutorial page is treated as Markdown text and as HTML otherwise

Example:

"# Title\r\n## Subtitle\r\nContent goes here"

​
MarkdownEnabled
boolean

Switches content between Markdown and HTML versions

Example:

true

​
Status
enum<string>

Status of the post (e.g., draft, published)

Available options:
published,
draft,
review
Example:

"published"

​
Title
string

Title of the post

Example:

"Get started this API Product"

​
Lede
string

Short summary or lead paragraph of the post

​
Type
string

Type of the post (e.g., article, news)

​
Path
string

URL path for the post

​
Categories
string[]

List of categories associated with the post

​
Tags
string[]

List of tags associated with the post

​
CreatedAt
string

Timestamp of when this post was created

Pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}$
Example:

"2023-06-25 13:37"

​
UpdatedAt
string

Timestamp of when this post was last updated

Pattern: ^\d{4}-\d{2}-\d{2} \d{2}:\d{2}$
Example:

"2023-06-25 13:37"