Skip to main content
GET
/
posts
/
{postId}
Get post by id
curl --request GET \
  --url https://{subdomain}.nudj.cx/api/v2/integration/posts/{postId} \
  --header 'x-api-token: <api-key>'
{
  "id": "<string>",
  "organisationId": "<string>",
  "communityId": "<string>",
  "details": {
    "title": "<string>",
    "description": "<string>",
    "light": {
      "primaryImageUrl": "<string>",
      "secondaryImageUrl": "<string>"
    },
    "dark": {
      "primaryImageUrl": "<string>",
      "secondaryImageUrl": "<string>"
    }
  },
  "likes": [
    "<string>"
  ],
  "disableComments": true,
  "disableLikes": true,
  "displayBannerOnPost": true,
  "status": "archived",
  "tags": [
    {
      "id": "<string>",
      "organisationId": "<string>",
      "value": "<string>",
      "config": {
        "filtering": [
          "achievement"
        ],
        "display": [
          "achievement"
        ],
        "iconifyIcon": "<string>"
      },
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "campaigns": [
    {
      "id": "<string>",
      "organisationId": "<string>",
      "name": "<string>",
      "startDate": "<string>",
      "endDate": "<string>",
      "status": "archived",
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  ],
  "availableAsTemplateForOrganisations": [
    "<string>"
  ],
  "isGlobalTemplate": true,
  "createdAt": "<string>",
  "createdBy": "<string>",
  "totalComments": 123,
  "totalLikes": 123,
  "content": "<string>",
  "startsAt": "<string>",
  "expiresAt": "<string>",
  "featured": true,
  "updatedAt": "<string>",
  "updatedBy": "<string>"
}

Authorizations

​
x-api-token
string
header
required

Headers

​
x-language
string

The language to return the post in. If not provided, the default language for the organisation will be used.

Path Parameters

​
postId
string
required

Response

Successful response

A post

​
id
string
required

The id of the post

​
organisationId
string
required

The organisation that the post belongs to

​
communityId
string
required

The community that the post belongs to

​
details
Details · object
required

The details of this post such as title, description, bannerUrl, logoUrl

​
likes
string[]
required

Array of user IDs who liked this post

​
disableComments
boolean
required

Whether comments are disabled on this post. Defaults to false.

​
disableLikes
boolean
required

Whether likes are disabled on this post. Defaults to false.

​
displayBannerOnPost
boolean
required

Whether to display a banner on this post. Defaults to false.

​
status
enum<string>
required

The status of the post

Available options:
archived,
draft,
expired,
live,
scheduled
​
tags
Tag · object[]
required

The tags the post is linked to

​
campaigns
Campaign · object[]
required

The campaigns the post is linked to

​
availableAsTemplateForOrganisations
string[]
required

The organisations that the post is available as a template for

​
isGlobalTemplate
boolean
required

Whether the post is a global template

​
createdAt
string
required

The date when this post was created

​
createdBy
string
required

The user who created this post

​
totalComments
number
required

The total number of comments on this post

​
totalLikes
number
required

The total number of likes on this post

​
content
string | null

The content of the post in HTML. Example:

Welcome to Your New Post

This is a placeholder post to demonstrate the capabilities of the editor. Feel free to explore and edit this content to see what you can do!

Basic Formatting

You can use bold, italic, underline, and strikethrough text to emphasize your content.

Lists

You can create a bullet list:

  • Item 1

  • Item 2

  • Item 3

Or a numberered list:

  1. First Item

  2. Second Item

  3. Third Item

Links

You can also add links to your content. For example, visit Example.com for more information.

Images

Including images is simple. Here is an example image:

Blockquotes

You can use blockquotes to highlight important quotes or information:

"This is a sample blockquote. It's great for highlighting quotes or important information in your post."

Feel free to edit this content and explore the various features of the editor. Happy posting!

​
startsAt
string | null

The date when this post becomes visible.

​
expiresAt
string | null

The date when this post expires.

​
featured
boolean | null
​
updatedAt
string | null

The date when this post was updated

​
updatedBy
string | null

The user who last updated this post